countries-dictionary 3.0.3__py3-none-any.whl → 3.1.0__py3-none-any.whl

{countries_dictionary-3.0.3.dist-info → countries_dictionary-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: countries_dictionary
-Version: 3.0.3
+Version: 3.1.0
 Summary: Provides a dictionary contains all members and observer states of the United Nations and information about them
 Author-email: Ngô Trần Quang Thiện <quangthienngotran@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -716,8 +716,163 @@ Countries Dictionary provides:
     - Postal code
 - Some functions which you might find helpful
 
-Before using, it is recommended to see the code on [GitHub](https://github.com/ThienFakeVN/countries_dictionary/) to understand how it works
-
 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
+#### Structure
+The Countries Dictionary has a structure like this:
+```python
+COUNTRIES = {
+    "Afghanistan": {
+        "formal name": "Islamic Emirate of Afghanistan",
+        "continents": ["Asia"],
+        "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"},
+    },
+    # ...
+}
+```
+
+#### 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",
+        "capital/administrative centre": "Maykop",
+        "area": 7792.0,
+        "population": 501038},
+    # ...
+}
+```
+
+#### 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",
+        "area": 135767.0,
+        "population": 5024279,
+        "House Representatives": 7,
+        "postal code": "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",
+        "administrative centre": "Hoàn Kiếm ward",
+        "area": 3359.84,
+        "population": 8807523},
+    # ...
+}
+```
+
+#### 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)
+```
+
+### 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"))
+```

{countries_dictionary-3.0.3.dist-info → countries_dictionary-3.1.0.dist-info}/RECORD

@@ -4,8 +4,8 @@ countries_dictionary/quick_functions.py,sha256=Ok62u2R88NubIrMtNSiHHzZ29orx_GYdr
 countries_dictionary/russia.py,sha256=3tmknQM_51PHmsF6TI6arFdjwPhWBEPHPiKP7PzXBmI,20119
 countries_dictionary/united_states.py,sha256=WJs5OrMMXinLPJWzt42hHPt89OLUC4qgifDUB9OrvoQ,15035
 countries_dictionary/vietnam.py,sha256=zRdwasxzwMJNbkNInljXzEu2gA9TDEI5F8cIM4TmBtg,6446
-countries_dictionary-3.0.3.dist-info/licenses/LICENCE,sha256=gcuuhKKc5-dwvyvHsXjlC9oM6N5gZ6umYbC8ewW1Yvg,35821
-countries_dictionary-3.0.3.dist-info/METADATA,sha256=SjxnZoCLkgMpWvRO6mPQVTlDGTDQau0nwas1RqnVzQY,43448
-countries_dictionary-3.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-countries_dictionary-3.0.3.dist-info/top_level.txt,sha256=7tkD6sfiOQ__y-Eb2rnPUU0Lbhr_wtFBNcRus-aU4Zw,21
-countries_dictionary-3.0.3.dist-info/RECORD,,
+countries_dictionary-3.1.0.dist-info/licenses/LICENCE,sha256=gcuuhKKc5-dwvyvHsXjlC9oM6N5gZ6umYbC8ewW1Yvg,35821
+countries_dictionary-3.1.0.dist-info/METADATA,sha256=D9tIPXzq9ssgGPHaRSW5Wzo893oQb_7Pe6i7AZJC83I,48288
+countries_dictionary-3.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+countries_dictionary-3.1.0.dist-info/top_level.txt,sha256=7tkD6sfiOQ__y-Eb2rnPUU0Lbhr_wtFBNcRus-aU4Zw,21
+countries_dictionary-3.1.0.dist-info/RECORD,,