worldref 1.1.0__tar.gz

worldref-1.1.0/LICENSE

@@ -0,0 +1,38 @@
+MIT License
+
+Copyright (c) 2026 arj-89 and worldref contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+The code in this repository is MIT licensed (above). The data in data/ is derived from third-party
+sources under their own licences; full texts are in LICENSES/:
+
+- Unicode CLDR (names, currencies, languages, locale data, subdivisions): Unicode-3.0.
+  Copyright (c) 1991-2026 Unicode, Inc.
+- Google libphonenumber metadata (phone rules) and Google address metadata (address formats):
+  Apache-2.0. Copyright (C) 2009 The Libphonenumber Authors; Copyright (C) Google Inc.
+  These files were modified: reduced to the fields worldref publishes and reshaped to its format.
+- World Bank World Development Indicators (population, area): CC-BY-4.0. Source: The World Bank.
+- Wikidata (capitals, coordinates, aliases, plugs, voltage, sports codes, nationality forms): CC0-1.0.
+- CIA World Factbook (English nationality, official names): public domain.
+- IANA Time Zone Database and root zone list: public domain.
+- flag-icons (SVG flags): MIT, Copyright (c) 2013 Panayiotis Lipiridis.
+- Website map (upstream/snapshot/world-map.json): Natural Earth, public domain.
+- Website fonts in site/assets/fonts (IBM Plex Sans Arabic, Noto Kufi Arabic, JetBrains Mono): OFL-1.1.
+
+Per-column sources, versions and every editorial decision are listed in data/sources.json.

worldref-1.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: worldref
+Version: 1.1.0
+Summary: Every country in Arabic, English, or both: names, nationalities, dial codes, phone validation, currencies, subdivisions.
+License: MIT
+Project-URL: Homepage, https://arj-89.github.io/worldref
+Project-URL: Source, https://github.com/arj-89/worldref
+Project-URL: Issues, https://github.com/arj-89/worldref/issues
+Project-URL: Changelog, https://github.com/arj-89/worldref/blob/main/CHANGELOG.md
+Keywords: countries,arabic,bilingual,nationality,phone-number,dial-codes,iso-3166,i18n,dataset
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Arabic
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Internationalization
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# worldref (Python)
+
+242 countries and territories in Arabic and English: names, aliases, phone plans, currencies, geo, locale, subdivisions, plus search, sorting and phone parsing. Standard library only, Python 3.9 or newer.
+
+## Install
+
+```sh
+pip install "git+https://github.com/arj-89/worldref@v1.1.0#subdirectory=python"
+```
+
+## Usage
+
+```python
+from worldref import countries, by_iso2, search, sort_countries, parse_phone, subdivisions
+
+sa = by_iso2("sa")
+print(sa.name_ar, sa.name_en, sa.flag)                  # السعودية Saudi Arabia 🇸🇦
+print([c.iso2 for c in search(countries(), "سعودية", "ar")][:3])
+print([c.name_en for c in sort_countries(countries(), "en", first="SA")][:3])
+p = parse_phone("0501234567", sa, countries())
+print(p.e164, p.valid, p.mobile)                        # +966501234567 True True
+print(len(subdivisions("SA")))
+```

worldref-1.1.0/README.md

@@ -0,0 +1,23 @@
+# worldref (Python)
+
+242 countries and territories in Arabic and English: names, aliases, phone plans, currencies, geo, locale, subdivisions, plus search, sorting and phone parsing. Standard library only, Python 3.9 or newer.
+
+## Install
+
+```sh
+pip install "git+https://github.com/arj-89/worldref@v1.1.0#subdirectory=python"
+```
+
+## Usage
+
+```python
+from worldref import countries, by_iso2, search, sort_countries, parse_phone, subdivisions
+
+sa = by_iso2("sa")
+print(sa.name_ar, sa.name_en, sa.flag)                  # السعودية Saudi Arabia 🇸🇦
+print([c.iso2 for c in search(countries(), "سعودية", "ar")][:3])
+print([c.name_en for c in sort_countries(countries(), "en", first="SA")][:3])
+p = parse_phone("0501234567", sa, countries())
+print(p.e164, p.valid, p.mobile)                        # +966501234567 True True
+print(len(subdivisions("SA")))
+```

worldref-1.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "worldref"
+version = "1.1.0"
+description = "Every country in Arabic, English, or both: names, nationalities, dial codes, phone validation, currencies, subdivisions."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+dependencies = []
+keywords = ["countries", "arabic", "bilingual", "nationality", "phone-number", "dial-codes", "iso-3166", "i18n", "dataset"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: Arabic",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Internationalization",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://arj-89.github.io/worldref"
+Source = "https://github.com/arj-89/worldref"
+Issues = "https://github.com/arj-89/worldref/issues"
+Changelog = "https://github.com/arj-89/worldref/blob/main/CHANGELOG.md"
+
+[tool.setuptools]
+packages = ["worldref"]
+
+[tool.setuptools.package-data]
+worldref = ["py.typed", "data/*.json"]

worldref-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

worldref-1.1.0/tests/test_worldref.py

@@ -0,0 +1,84 @@
+import json
+import unittest
+from pathlib import Path
+
+import worldref
+from worldref import (
+    by_iso2, countries, normalize, parse_phone, search, sort_countries, subdivisions, western_digits,
+)
+
+V = json.loads((Path(__file__).resolve().parent / ".." / ".." / "tests" / "vectors.json").read_text(encoding="utf-8"))
+
+
+class Vectors(unittest.TestCase):
+    def test_western_digits(self) -> None:
+        for i, o in V["westernDigits"]:
+            self.assertEqual(western_digits(i), o, i)
+
+    def test_normalize(self) -> None:
+        for i, o in V["normalize"]:
+            self.assertEqual(normalize(i), o, i)
+
+    def test_search(self) -> None:
+        for c in V["search"]:
+            hits = search(countries(), c["query"], c["lang"])
+            if "count" in c:
+                self.assertEqual(len(hits), c["count"], c["query"])
+            if c.get("first"):
+                self.assertTrue(hits, c["query"])
+                self.assertEqual(hits[0].iso2, c["first"], f'{c["query"]} -> {[h.iso2 for h in hits[:3]]}')
+
+    def test_sort(self) -> None:
+        for c in V["sort"]:
+            n = len(c["head"])
+            head = [x.iso2 for x in sort_countries(countries(), c["lang"], c["first"])[:n]]
+            self.assertEqual(head, c["head"], f'{c["lang"]} {c["first"]}')
+
+    def test_phone(self) -> None:
+        for c in V["phone"]:
+            country = by_iso2(c["country"])
+            assert country is not None
+            p = parse_phone(c["input"], country, countries())
+            self.assertIsNotNone(p, c["input"])
+            assert p is not None
+            got = (p.e164, p.iso2, p.valid, p.mobile)
+            self.assertEqual(got, (c["e164"], c["iso2"], c["valid"], c["mobile"]), c["input"])
+
+    def test_absent(self) -> None:
+        for token in V["absent"]:
+            self.assertIsNone(by_iso2(token), token)
+            self.assertFalse(any(token in (c.iso2, c.iso3, c.name_en, c.name_ar) for c in countries()), token)
+            self.assertFalse([c for c in search(countries(), token, "en") if c.iso2 == token], token)
+
+
+class Data(unittest.TestCase):
+    def test_shape(self) -> None:
+        self.assertEqual(len(countries()), 242)
+        sa = by_iso2("sa")
+        assert sa is not None
+        self.assertEqual(sa.iso2, "SA")
+        self.assertEqual(sa.phone[0].calling_code, "+966")
+        self.assertIsNone(by_iso2("ZZ"))
+
+    def test_subdivisions(self) -> None:
+        self.assertEqual(len(subdivisions()), 5012)
+        sa = subdivisions("sa")
+        self.assertTrue(sa and all(s.iso2 == "SA" for s in sa))
+
+    def test_every_pattern_compiles(self) -> None:
+        for c in countries():
+            for p in c.phone:
+                for pat in (p.pattern, p.mobile_pattern, p.leading_digits):
+                    if pat:
+                        worldref.helpers._regex(pat)
+
+    def test_format_national(self) -> None:
+        sa = by_iso2("SA")
+        assert sa is not None
+        plan = sa.phone[0]
+        self.assertTrue(worldref.is_valid_mobile("0501234567", sa))
+        self.assertEqual(worldref.format_national("12", plan), "12")
+
+
+if __name__ == "__main__":
+    unittest.main()

worldref-1.1.0/worldref/__init__.py

@@ -0,0 +1,15 @@
+"""worldref: countries and territories in Arabic and English."""
+from .data import by_iso2, countries, subdivisions
+from .helpers import ParsedPhone, format_national, is_valid_mobile, parse_phone, search, sort_countries
+from .models import (
+    Address, Country, Currency, Emergency, Geo, Language, Locale, Nationality, PhonePlan, Sports, Subdivision, Travel,
+)
+from .text import normalize, western_digits
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "Address", "Country", "Currency", "Emergency", "Geo", "Language", "Locale", "Nationality", "ParsedPhone",
+    "PhonePlan", "Sports", "Subdivision", "Travel", "by_iso2", "countries", "format_national", "is_valid_mobile",
+    "normalize", "parse_phone", "search", "sort_countries", "subdivisions", "western_digits",
+]