countries-dictionary 3.1.4__tar.gz → 4.0.1__tar.gz

{countries_dictionary-3.1.4 → countries_dictionary-4.0.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: countries_dictionary
-Version: 3.1.4
-Summary: Provides a dictionary contains all members and observer states of the United Nations and information about them
+Version: 4.0.1
+Summary: Provides a dictionary contains countries and unrecognised states and information about them
 Author-email: Ngô Trần Quang Thiện <quangthienngotran@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -679,58 +679,31 @@ License:                     GNU GENERAL PUBLIC LICENSE
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 Project-URL: Homepage, https://github.com/ThienFakeVN/countries_dictionary/
 Project-URL: Repository, https://github.com/ThienFakeVN/countries_dictionary/
-Keywords: countries,dictionary,united nations,states,russia,united states,vietnam,iso
+Keywords: countries,states,dictionary,united nations,russia,united states,vietnam,iso
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENCE
 Dynamic: license-file
 
 # Countries Dictionary
-Countries Dictionary provides: 
-- A dictionary contains all members and observer states of the United Nations and information about them:
-    - Formal name
-    - Continent(s) of the country's mainland
-    - Area and land area (in square kilometre)
-    - Population
-    - Official language(s)
-    - Nominal GDP (in dollar)
-    - Human Development Index
-    - ISO 3166-1 codes
-- Another dictionary contains all federal subjects of the Russian Federation (including occupied zones in Ukraine) and information about them:
-    - Federal district
-    - Economic region
-    - Capital or administrative centre
-    - Area (in square kilometre)
-    - Population
-- Another one contains all provinces and municipalities of the Socialist Republic of Vietnam and information about them:
-    - Region
-    - Administrative centre
-    - Area (in square kilometre)
-    - Population
-- Another one contains all states, federal district and inhabited territories of the United States of America and information about them:
-    - Capital
-    - Date of ratification/establishment/acquiring
-    - Area (in square kilometre)
-    - Population
-    - House Representatives
-    - Postal code
-- Some functions which you might find helpful
+Countries Dictionary is a data-oriented module which provides dictionaries of countries and states, from members of UN to unrecognised ones.
 
 I created this module as an offline source of countries' information which is easy to access and use by coders.
 
 See [CHANGELOG.md](https://github.com/ThienFakeVN/countries_dictionary/blob/main/CHANGELOG.md) for changes of releases.
 
-Before using, it is recommended to see the code on [GitHub](https://github.com/ThienFakeVN/countries_dictionary/) or the below section to understand how the module works and how you can use it
-
+Before using, it is recommended to see the code on [GitHub](https://github.com/ThienFakeVN/countries_dictionary/) <!--or the below section--> to understand how the module works and how you can use it.
+<!--
 ## Codes
 ### Main Countries Dictionary
-#### Structure
 The Countries Dictionary has a structure like this:
 ```python
 COUNTRIES = {
     "Afghanistan": {
         "formal name": "Islamic Emirate of Afghanistan",
+        "motto": "There is no god but God; Muhammad is the messenger of God",
         "continents": ["Asia"],
+        "landlocked": True,
         "area": 652864.0,
         "land area": 652230.0,
         "population": 42045000,
@@ -743,115 +716,58 @@ COUNTRIES = {
 }
 ```
 
-#### Usage example
-```python
-from countries_dictionary import COUNTRIES # Remember to import the module!
-
-# Prints the formal name of the country
-print(COUNTRIES["Vietnam"]["formal name"])
-
-# Compares the population of two countries
-print(COUNTRIES["North Korea"]["population"] > COUNTRIES["South Korea"]["population"])
-print(COUNTRIES["North Korea"]["population"] == COUNTRIES["South Korea"]["population"])
-print(COUNTRIES["North Korea"]["population"] < COUNTRIES["South Korea"]["population"])
-
-# Creates the list of all countries
-list_of_countries = list(COUNTRIES.keys())
-print(list_of_countries)
-```
-
 ### Russia dictionary
-#### Structure
 The Russia dictionary has a structure like this:
 ```python
 RUSSIA = {
     "Adygea": {
         "federal district": "Southern",
         "economic region": "North Caucasus",
+        "landlocked": True,
         "capital/administrative centre": "Maykop",
         "area": 7792.0,
-        "population": 501038},
+        "population": 501038,
+        "ISO 3166-2:RU": "RU-AD",
+    },
     # ...
 }
 ```
 
-#### Usage example
-```python
-from countries_dictionary.russia import RUSSIA # Remember to import the module
-
-# Prints the administrative centre of a krai
-print(RUSSIA["Primorsky Krai"]["capital/administrative centre"])
-
-# Sees if the two federal subjects are in the same federal district
-print(RUSSIA["Tuva"]["federal district"] == RUSSIA["Altai Republic"]["federal district"])
-
-# Creates the list of all federal subjects
-list_of_federal_subjects = list(RUSSIA.keys())
-print(list_of_federal_subjects)
-```
-
 ### United States dictionary
-#### Structure
 The United States dictionary has a structure like this:
 ```python
 UNITED_STATES = {
     "Alabama": {
         "capital": "Montgomery",
         "date of ratification/establishment/acquiring": "1819.12.14",
+        "landlocked": False,
         "area": 135767.0,
         "population": 5024279,
         "House Representatives": 7,
-        "postal code": "AL",
-    }
+        "ISO 3166-2:US": "US-AL",
+    },
     # ...
 }
 ```
 
-#### Usage example
-```python
-from countries_dictionary.united_states import UNITED_STATES # Remember to import the module...
-
-# Prints the postal code of a state
-print(UNITED_STATES["Ohio"]["postal code"])
-
-# Compares the numbers of House Representatives of two states
-print(UNITED_STATES["Oklahoma"]["House Representatives"] > UNITED_STATES["Connecticut"]["House Representatives"])
-print(UNITED_STATES["Oklahoma"]["House Representatives"] == UNITED_STATES["Connecticut"]["House Representatives"])
-print(UNITED_STATES["Oklahoma"]["House Representatives"] < UNITED_STATES["Connecticut"]["House Representatives"])
-
-# Creates the list of all states
-list_of_states = list(UNITED_STATES.keys())
-print(list_of_states)
-```
-
 ### Vietnam dictionary
-#### Structure
 The Vietnam dictionary has a structure like this:
 ```python
 VIETNAM = {
     "Hanoi": {
         "region": "Red River Delta",
+        "landlocked": True,
         "administrative centre": "Hoàn Kiếm ward",
         "area": 3359.84,
-        "population": 8807523},
+        "population": 8807523,
+        "ISO 3166-2:VN": "VN-HN",
+    },
     # ...
 }
 ```
 
-#### Usage example
-```python
-from countries_dictionary.vietnam import VIETNAM # Of course...
-
-# Prints the population of a province
-print(VIETNAM["Ho Chi Minh City"]["population"])
-
-# Sees if the two provinces are in the same region
-print(VIETNAM["Nghệ An province"]["region"] == VIETNAM["Hà Tĩnh province"]["region"])
-
-# Creates the list of all provinces
-list_of_provinces = list(VIETNAM.keys())
-print(list_of_provinces)
-```
+### Countries Languages
+Unused, as of now...
 
 ### Quick functions
 There are many functions in this submodule.
@@ -870,9 +786,46 @@ print(iso["Russia"]["ISO 3166-2"])
 ### ISO finder
 *ISO finder* is a module which provides a function which has the same name. *ISO finder* can find a country based on the provided ISO code. Note that it does not include US states' postal codes.
 ```python
-from countries_dictionary.iso_finder import iso_finder
+from countries_dictionary.iso_finder import iso_finder # 🥀
 
 print(iso_finder("VN"))
 print(iso_finder("RUS"))
 print(iso_finder("840"))
 ```
+
+### Unrecognised states
+The unrecognised states Dictionary has a structure like this:
+
+```python
+UNRECOGNISED_STATES = {
+    "Cook Islands": {
+        "formal name": "Cook Islands",
+        "motto": "",
+        "continents": ["Oceania"],
+        "landlocked": False,
+        "area": 236.0,
+        "land area": 236.0,
+        "population": 15040,
+        "official languages": ["English", "Cook Islands Māori", "Pukapukan"],
+        "nominal GDP": 384000000,
+        "HDI": 0,
+        "ISO 3166-1": {"alpha-2": "CK", "alpha-3": "COK", "numeric": "184"},
+    },
+    # ...
+    # Additional information may be added as comments in the codes
+}
+```
+
+### Transnistria
+The Transnistria Dictionary has a structure like this:
+```python
+TRANSNISTRIA = {
+    "Camenca": {
+        "administrative centre": "Camenca",
+        "area": 434.5,
+        "population": 21000,
+    },
+    # ...
+}
+```
+-->

countries_dictionary-4.0.1/README.md

@@ -0,0 +1,144 @@
+# Countries Dictionary
+Countries Dictionary is a data-oriented module which provides dictionaries of countries and states, from members of UN to unrecognised ones.
+
+I created this module as an offline source of countries' information which is easy to access and use by coders.
+
+See [CHANGELOG.md](https://github.com/ThienFakeVN/countries_dictionary/blob/main/CHANGELOG.md) for changes of releases.
+
+Before using, it is recommended to see the code on [GitHub](https://github.com/ThienFakeVN/countries_dictionary/) <!--or the below section--> to understand how the module works and how you can use it.
+<!--
+## Codes
+### Main Countries Dictionary
+The Countries Dictionary has a structure like this:
+```python
+COUNTRIES = {
+    "Afghanistan": {
+        "formal name": "Islamic Emirate of Afghanistan",
+        "motto": "There is no god but God; Muhammad is the messenger of God",
+        "continents": ["Asia"],
+        "landlocked": True,
+        "area": 652864.0,
+        "land area": 652230.0,
+        "population": 42045000,
+        "official languages": ["Dari", "Pashto"],
+        "nominal GDP": 16417000000,
+        "HDI": 0.496,
+        "ISO 3166-1": {"alpha-2": "AF", "alpha-3": "AFG", "numeric": "004"},
+    },
+    # ...
+}
+```
+
+### Russia dictionary
+The Russia dictionary has a structure like this:
+```python
+RUSSIA = {
+    "Adygea": {
+        "federal district": "Southern",
+        "economic region": "North Caucasus",
+        "landlocked": True,
+        "capital/administrative centre": "Maykop",
+        "area": 7792.0,
+        "population": 501038,
+        "ISO 3166-2:RU": "RU-AD",
+    },
+    # ...
+}
+```
+
+### United States dictionary
+The United States dictionary has a structure like this:
+```python
+UNITED_STATES = {
+    "Alabama": {
+        "capital": "Montgomery",
+        "date of ratification/establishment/acquiring": "1819.12.14",
+        "landlocked": False,
+        "area": 135767.0,
+        "population": 5024279,
+        "House Representatives": 7,
+        "ISO 3166-2:US": "US-AL",
+    },
+    # ...
+}
+```
+
+### Vietnam dictionary
+The Vietnam dictionary has a structure like this:
+```python
+VIETNAM = {
+    "Hanoi": {
+        "region": "Red River Delta",
+        "landlocked": True,
+        "administrative centre": "Hoàn Kiếm ward",
+        "area": 3359.84,
+        "population": 8807523,
+        "ISO 3166-2:VN": "VN-HN",
+    },
+    # ...
+}
+```
+
+### Countries Languages
+Unused, as of now...
+
+### Quick functions
+There are many functions in this submodule.
+```python
+import countries_dictionary.quick_functions as qf # What have you expected?
+
+# Converts the dictionary into JSON and creates/overwrites a JSON file which contains the converted dictionary
+with open("countries_dictionary.json", "w") as f:
+    f.write(qf.json_dictionary(indent=4))
+
+# Prints a ISO 3166-2 code of a country
+iso = qf.countries_iso_3166_2()
+print(iso["Russia"]["ISO 3166-2"])
+```
+
+### ISO finder
+*ISO finder* is a module which provides a function which has the same name. *ISO finder* can find a country based on the provided ISO code. Note that it does not include US states' postal codes.
+```python
+from countries_dictionary.iso_finder import iso_finder # 🥀
+
+print(iso_finder("VN"))
+print(iso_finder("RUS"))
+print(iso_finder("840"))
+```
+
+### Unrecognised states
+The unrecognised states Dictionary has a structure like this:
+
+```python
+UNRECOGNISED_STATES = {
+    "Cook Islands": {
+        "formal name": "Cook Islands",
+        "motto": "",
+        "continents": ["Oceania"],
+        "landlocked": False,
+        "area": 236.0,
+        "land area": 236.0,
+        "population": 15040,
+        "official languages": ["English", "Cook Islands Māori", "Pukapukan"],
+        "nominal GDP": 384000000,
+        "HDI": 0,
+        "ISO 3166-1": {"alpha-2": "CK", "alpha-3": "COK", "numeric": "184"},
+    },
+    # ...
+    # Additional information may be added as comments in the codes
+}
+```
+
+### Transnistria
+The Transnistria Dictionary has a structure like this:
+```python
+TRANSNISTRIA = {
+    "Camenca": {
+        "administrative centre": "Camenca",
+        "area": 434.5,
+        "population": 21000,
+    },
+    # ...
+}
+```
+-->