Merge branch 'main' of https://github.com/jcari-dev/pyworldatlas-docu…

…mentation
jcari-dev · Aug 25, 2024 · a5b2ed6 · a5b2ed6
2 parents e9f221c + e6a01c4
commit a5b2ed6
Showing 1 changed file with 84 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
+## Issue Tracker
+
+Here for the Issue tracker? Please find it here: [pyworldatlas-issue-tracker](https://github.com/jcari-dev/pyworldatlas-issue-tracker)
 
 # pyworldatlas
 
@@ -28,7 +31,7 @@ import pyworldatlas as pwa
 atlas = pwa.Atlas()
 
 # Fetch the profile of a country by name
-profile = atlas.get_country_profile("United States")
+profile = atlas.get_country_profile("Albania")
 
 # Display the profile information
 print(profile)
@@ -38,22 +41,89 @@ Example output:
 
 ```python
 {
-    'capital': {
-        'name': 'Washington, D.C.',
-        'coordinates_degree_east': -77.0369,
-        'coordinates_degree_north': 38.9072,
-        'is_largest_city': False,
+    "capital": {
+        "name": "Tirana",
+        "coordinates_degree_east": 19.49,
+        "coordinates_degree_north": 41.19,
+        "is_largest_city": True
+    },
+    "area": {
+        "total_km2_including_disputed_territories": None,
+        "total_km2_internationally_recognized": 28748.0,
+        "water_percentage": 4.7
+    },
+    "driving_side": "Right",
+    "calling_code": "355",
+    "iso_3166_code": "AL",
+    "internet_tld": ".al",
+    "population": {
+        "total": 2994667,
+        "density_km2": 111.1,
+        "date_year": 2011
+    },
+    "gini_index": {
+        "value": 26.7,
+        "year": 2005
+    },
+    "gdp": {
+        "ppp_trillions": 0.025035,
+        "ppp_per_capita": 7780.0,
+        "nominal_total_trillions": 0.013292,
+        "nominal_per_capita": 4131.0,
+        "ppp_gdp_year": 2011,
+        "nominal_gdp_year": 2011
+    },
+    "government": {
+        "president": "Bajram Begaj",
+        "prime_minister": "Edi Rama",
+        "declaration_of_state_sovereignty": "1912-11-28",
+        "other_leader_title": None,
+        "other_leader": None,
+        "government_type": "Parliamentary republic",
+        "president_assumed_office": "2022-07-24",
+        "prime_minister_assumed_office": "2013-09-15",
+        "other_leader_assumed_office": None
+    },
+    "official_names": {
+        "Albanian": "Republika e Shqipërisë",
+        "English": "Republic of Albania"
     },
-    'largest_city': {
-        'name': 'New York City',
-        'coordinates_degree_east': -74.0060,
-        'coordinates_degree_north': 40.7128,
+    "anthem": {
+        "Albanian": "Himni i Flamurit",
+        "English": "Hymn to the Flag"
     },
-    'driving_side': 'Right',
-    'calling_code': '+1',
-    'iso_3166_code': 'US',
-    'internet_tld': '.us',
+    "motto": {
+        "Albanian": "Ti, Shqipëri, më jep nder, më jep emrin Shqiptar",
+        "English": "You, Albania, give me honor, give me the name Albanian"
+    },
+    "religion": {
+        "Islam": 50.67,
+        "Christianity": 16.02,
+        "Non-denominational": 13.83,
+        "Atheism": 3.55,
+        "Others": 0.15,
+        "Undeclared": 15.77
+    },
+    "ethnic_groups": {
+        "Albanians": 98.2,
+        "Others": 1.8
+    },
+    "languages": {
+        "official_languages": ["Albanian"],
+        "recognized_languages": []
+    },
+    "currency": {
+        "name": "Lek",
+        "symbol": "L",
+        "iso_code": "ALL"
+    },
+    "continent": "Europe",
+    "timezones": {
+        "UTC+1": {"DST": 1},
+        "UTC+2": {"DST": 1}
+    }
 }
+
 ```
 
 ## Documentation