diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index 92b8e5f..1e68fa6 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -35,7 +35,7 @@ Quick Links Contributing ------------ -Contributions are welcome! Please see the `Contributing Guide `_ for more details. +Please see the `Contributing Guide `_ for more details. License ------- diff --git a/index.html b/index.html index 22e209f..c4f5934 100644 --- a/index.html +++ b/index.html @@ -179,7 +179,7 @@

Quick Links

Contributing

-

Contributions are welcome! Please see the Contributing Guide for more details.

+

Please see the Contributing Guide for more details.

License

diff --git a/searchindex.js b/searchindex.js index 153e048..b28d84a 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"0.0.3 - 2024-08-16": [[1, "id5"]], "0.0.4 - 2024-08-19": [[1, "id4"]], "0.0.5 - 2024-08-19": [[1, "id3"]], "0.0.6 - 2024-08-20": [[1, "id2"]], "0.0.7 - 2024-08-24": [[1, "id1"]], "API Reference": [[0, null]], "Additional Features": [[0, "additional-features"]], "Atlas Class": [[0, "atlas-class"]], "Basic Usage": [[6, "basic-usage"]], "Changelog": [[1, null]], "Classes and Methods": [[0, "classes-and-methods"]], "Contents:": [[7, null]], "Contributing": [[2, null], [7, "contributing"]], "Countries in pyworldatlas Database": [[3, "id1"]], "Country Data": [[3, null]], "CountryNotFoundError": [[0, "countrynotfounderror"]], "Data Collection Approach": [[11, "data-collection-approach"]], "Database Download": [[4, null]], "Does pyworldatlas depend on any external libraries?": [[5, "does-pyworldatlas-depend-on-any-external-libraries"]], "Does pyworldatlas require an internet connection to work?": [[5, "does-pyworldatlas-require-an-internet-connection-to-work"]], "Download Link": [[4, "download-link"]], "Error Handling": [[0, "error-handling"]], "Example Output": [[6, "example-output"]], "Example: Fetching a Country\u2019s Profile": [[6, "example-fetching-a-country-s-profile"]], "FAQ": [[5, null]], "File Details": [[4, "file-details"]], "Future Plans": [[11, "future-plans"]], "Getting Started": [[6, null]], "Goals and Focus Areas": [[11, "goals-and-focus-areas"]], "How can I verify the source of the data for each country?": [[5, "how-can-i-verify-the-source-of-the-data-for-each-country"]], "How do I report an issue or suggest a feature?": [[5, "how-do-i-report-an-issue-or-suggest-a-feature"]], "How does pyworldatlas ensure political neutrality?": [[5, "how-does-pyworldatlas-ensure-political-neutrality"]], "Installation": [[8, null]], "Installing pyworldatlas": [[8, "installing-pyworldatlas"]], "Introduction": [[9, null]], "Key Benefits": [[9, "key-benefits"]], "Key Features": [[7, "key-features"]], "License": [[7, "license"], [10, null]], "MIT License": [[10, "mit-license"]], "Next Steps": [[8, "next-steps"], [9, "next-steps"]], "Prerequisites": [[6, "prerequisites"]], "Quick Links": [[7, "quick-links"]], "Requirements": [[8, "requirements"]], "Roadmap": [[11, null]], "Verifying Installation": [[8, "verifying-installation"]], "Verifying the File": [[4, "verifying-the-file"]], "Welcome to pyworldatlas\u2019s Documentation": [[7, null]], "What Next?": [[6, "what-next"]], "What data can I get from pyworldatlas?": [[5, "what-data-can-i-get-from-pyworldatlas"]], "What is pyworldatlas?": [[9, "what-is-pyworldatlas"]], "What is the minimum Python version required to use pyworldatlas?": [[5, "what-is-the-minimum-python-version-required-to-use-pyworldatlas"]], "Where does pyworldatlas source its data from?": [[5, "where-does-pyworldatlas-source-its-data-from"]], "Who is it for?": [[9, "who-is-it-for"]], "get_countries (WIP)": [[0, "get-countries-wip"]], "get_country_profile": [[0, "get-country-profile"]], "get_progress": [[0, "get-progress"]]}, "docnames": ["api_reference", "changelog", "contributing", "country_data", "database_download", "faq", "getting_started", "index", "installation", "introduction", "license", "roadmap"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["api_reference.rst", "changelog.rst", "contributing.rst", "country_data.rst", "database_download.rst", "faq.rst", "getting_started.rst", "index.rst", "installation.rst", "introduction.rst", "license.rst", "roadmap.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 5, 10, 11], "0": 7, "0060": 6, "0369": 6, "08": 7, "1": [0, 6, 11], "10": 4, "1000000": 0, "16": 7, "19": 7, "1fd820212aa6cbc3f07ab32c3a4db3b7f683c1101a80a7649ddcf2fdf0aa7bd0": 4, "2": [0, 11], "20": 7, "2024": [7, 10], "24": 7, "256": 4, "285": 0, "288": 4, "2e8b9594da57e0e80f0a692530136dffb06d631375a159ea1bd242642d837760": 4, "3": [0, 5, 7, 8], "3166": [0, 3], "33": 0, "35": 1, "3522": 0, "38": 6, "4": 7, "40": 6, "48": 0, "5": [7, 11], "6": 7, "7": 7, "7128": 6, "74": 6, "77": 6, "8": [1, 5, 8], "8566": 0, "9": [5, 8], "9072": 6, "A": [0, 5, 10], "AND": 10, "AS": 10, "As": 11, "At": 2, "BE": 10, "BUT": 10, "FOR": 10, "For": [5, 8, 10], "IN": 10, "If": [3, 5, 6], "In": [2, 6], "It": [0, 5], "NO": 10, "NOT": 10, "No": [5, 7, 9], "OF": 10, "OR": 10, "THE": 10, "TO": 10, "That": 10, "The": [0, 2, 4, 5, 6, 9, 10, 11], "Then": 6, "To": [4, 6, 8, 9], "WITH": 10, "With": 6, "__version__": 8, "abl": [1, 6], "about": [0, 4, 5, 6, 7, 9, 11], "abov": 10, "accept": 2, "access": [0, 4, 6, 7, 9, 11], "accordingli": 1, "accur": [5, 9, 11], "action": 10, "actual": 11, "ad": [1, 3, 11], "add": 11, "addit": [5, 7, 11], "af": 3, "afghanistan": [1, 3], "aim": [5, 11], "al": 3, "albania": [1, 3], "algeria": [1, 3], "algorithm": 4, "all": [3, 4, 5, 10], "allow": 5, "alpha": 0, "alreadi": 6, "altern": 8, "alwai": [5, 11], "am": 2, "an": [6, 7, 9, 10], "analysi": 9, "ani": [2, 6, 7, 9, 10], "anyon": 9, "api": [5, 6, 7], "applic": 9, "approach": [1, 7], "ar": [1, 5, 7, 9], "area": [0, 7], "aris": 10, "around": 11, "arrai": 9, "articl": [5, 11], "asia": 0, "ask": 5, "associ": 10, "assum": 0, "atla": [6, 7], "attribut": 10, "author": 10, "autom": 11, "automat": 8, "avail": [0, 3, 4, 5, 6, 8, 11], "avoid": 5, "bar": 11, "base": 1, "basic": [1, 7], "becaus": [10, 11], "been": [0, 8], "befor": [2, 6], "begin": [6, 9], "behav": 1, "being": 10, "below": [3, 4, 5, 6, 7, 10, 11], "benefit": 7, "best": 5, "better": 1, "build": [9, 11], "built": 5, "bump": 1, "c": [6, 10], "call": [5, 6], "calling_cod": [0, 6], "can": [4, 6, 7, 8], "capit": [0, 5, 6], "care": 11, "carefulli": 11, "caridad": 10, "changelog": 7, "charg": 10, "check": [5, 6, 8], "citi": [0, 1, 5, 6], "claim": 10, "class": [6, 7], "cli": 1, "code": [0, 2, 3, 10], "collabor": 2, "collect": 7, "command": [1, 4, 8], "compar": 11, "compil": [4, 5, 7, 9, 11], "complet": [0, 1, 2, 11], "complex": 11, "comprehens": [6, 9, 11], "compress": 4, "condit": 10, "confirm": 8, "connect": [7, 10], "consid": 11, "consist": 11, "contain": [0, 4, 6], "contin": [0, 1], "continu": 0, "contract": 10, "contribut": [5, 11], "conveni": 5, "coordin": 1, "coordinates_degree_east": [0, 6], "coordinates_degree_north": [0, 6], "copi": 10, "copyright": 10, "core": 11, "countri": [0, 1, 4, 7, 9, 11], "countrynotfounderror": 7, "cover": 9, "coverag": 11, "creat": [5, 6], "criteria": 0, "curat": 11, "currenc": 9, "current": [0, 3, 4, 8, 11], "custom": 0, "d": 6, "damag": 10, "data": [0, 1, 6, 7, 9], "databas": [1, 5, 7, 11], "dataset": [0, 1, 11], "date": [5, 9], "daylight": 1, "de": 1, "deal": 10, "decompress": 1, "deeper": 11, "default": 4, "depend": [4, 7, 9, 11], "deprec": 1, "design": [0, 5, 9], "detail": [0, 2, 6, 7, 9], "develop": [9, 11], "dict": 0, "dictionari": [0, 6], "differ": 1, "displai": [6, 8], "distribut": 10, "do": [7, 10], "document": [1, 10, 11], "doe": [7, 11], "done": [4, 11], "download": [1, 7], "drive": 6, "driving_sid": [0, 6], "dst": 1, "dz": 3, "e": [0, 1], "each": [0, 1, 7, 11], "earlier": 1, "easi": [7, 9], "easili": 9, "econom": [5, 9], "effici": [0, 7, 9], "either": 8, "encount": 5, "enhanc": [1, 11], "ensur": [1, 4, 6, 7, 11], "environ": 8, "error": 7, "especi": 11, "ethnic": 9, "europ": 0, "event": 10, "everi": [7, 9], "everyth": 5, "evolv": [0, 11], "exact": 5, "exampl": [0, 7], "except": 0, "expand": [1, 11], "expect": 11, "explor": [6, 9], "express": 10, "extens": 7, "extern": [2, 7, 9], "facilit": 1, "fals": 6, "faq": 7, "fast": [7, 9], "featur": [2, 6, 11], "feedback": 2, "feel": [2, 5], "fetch": [0, 7], "few": 6, "field": 1, "file": [7, 10], "filehash": 4, "filter": 0, "final": 1, "finish": 1, "fit": 10, "fix": 1, "flexibl": 9, "float": 0, "focu": [5, 7], "follow": [1, 4, 7, 8, 9, 10, 11], "footprint": 9, "format": 11, "found": 0, "foundat": 6, "fr": 0, "fragment": 1, "franc": 0, "free": [2, 5, 10], "frequent": 5, "from": [4, 7, 10], "full": 5, "fulli": 2, "furnish": 10, "further": 11, "futur": 7, "g": [0, 1], "gdp": [0, 5, 7, 9], "geograph": 9, "geographi": [5, 7], "germani": 0, "get": [4, 7, 8, 9], "get_countri": 7, "get_country_profil": [1, 6, 7], "get_progress": 7, "gini": 9, "github": [2, 5, 7], "given": 10, "global": [9, 11], "goal": [2, 5, 7], "good": 10, "govern": [0, 5, 7, 9], "grant": 10, "graph": 11, "group": 9, "growth": 11, "guess": 10, "guid": [6, 7, 8, 9], "guidelin": 2, "gz": 4, "gzip": [1, 4], "ha": [0, 8, 9], "handl": [5, 7], "hash": 4, "hassl": 9, "have": [5, 6, 10], "haven": 6, "help": [0, 6], "here": 6, "herebi": 10, "higher": 5, "holder": 10, "how": [7, 8], "howev": [5, 11], "i": [0, 1, 2, 3, 4, 6, 7, 8, 10, 11], "id": [1, 5, 11], "identifi": 0, "implement": 11, "impli": 10, "import": [0, 6, 8], "improv": [0, 11], "includ": [2, 4, 5, 6, 7, 9, 10], "incorpor": 1, "index": 9, "indic": 3, "inform": [0, 3, 4, 5, 6, 7, 9, 11], "initi": 1, "instal": [4, 6, 7, 9], "instanc": 6, "instruct": 7, "integr": [4, 7, 9], "interest": [2, 9], "interfac": [0, 6], "intern": 5, "internet": 7, "internet_tld": [0, 6], "interpret": 8, "introduc": [1, 11], "introduct": 7, "intuit": 0, "is_largest_c": [0, 6], "iso": [0, 3], "iso_3166_cod": [0, 6], "issu": [2, 7], "itali": 0, "its": [3, 6, 7], "jorg": 10, "jump": 9, "just": [6, 9], "kb": 4, "kind": 10, "languag": [1, 9], "largest": [0, 1, 5, 6], "largest_c": 6, "last_upd": 1, "latest": 4, "leader": 1, "learn": [8, 11], "let": 10, "level": 9, "liabil": 10, "liabl": 10, "librari": 7, "lightweight": [5, 7, 9], "like": [5, 6], "limit": 10, "line": 8, "linux": 4, "list": [0, 3, 5, 6], "ll": 6, "local": 5, "long": 10, "look": [6, 10], "lot": 1, "mac": 4, "mai": 11, "main": [0, 5], "make": [7, 8], "mani": 1, "manual": [4, 5, 11], "match": 0, "max_gdp": 0, "max_popul": 0, "maximum": [0, 5, 8], "me": 11, "mean": 10, "meantim": 2, "merchant": 10, "merg": 10, "method": [1, 5, 6, 7, 8, 9, 11], "mid": 11, "min_gdp": 0, "min_popul": 0, "mind": 9, "minim": 9, "minimum": [0, 7], "minist": 1, "mit": 7, "model": 1, "modifi": 10, "more": [0, 1, 5, 6, 7, 9], "much": 9, "name": [0, 1, 5, 6, 7, 9], "nearing": 11, "need": [1, 5, 9], "needs_upd": 1, "neutral": 7, "new": [5, 6, 11], "next": 7, "nonexistentland": 0, "noninfring": 10, "notic": 10, "now": 1, "number": 11, "object": 5, "obtain": 10, "offer": [7, 9], "offic": 1, "offici": [0, 1, 5, 7, 9], "onc": [2, 6, 8, 11], "ongo": 11, "open": [2, 11], "oper": 4, "opinion": 5, "opportun": 11, "optim": 11, "option": [0, 4, 6], "other": [0, 1, 6, 10], "otherwis": [3, 10], "our": 5, "out": [6, 10], "output": [0, 7], "overview": 0, "packag": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11], "page": [1, 3, 7, 9, 10], "paramet": 0, "pari": 0, "particular": 10, "per": 11, "percentag": 0, "perform": [5, 8, 9, 11], "period": 11, "permiss": 10, "permit": 10, "person": [2, 9, 10, 11], "pip": 8, "plan": 7, "pleas": [5, 7], "polish": 1, "polit": 7, "popul": [0, 5, 7, 9], "portion": 10, "powershel": 4, "prerequisit": 7, "present": 3, "presid": 1, "primarili": 5, "prime": 1, "print": [0, 6, 8], "prior": 1, "prioriti": 11, "proce": 8, "process": 11, "profil": [0, 1, 5, 7, 9], "progress": [0, 11], "project": [2, 7, 9, 10], "properli": 5, "provid": [0, 2, 5, 6, 9, 10, 11], "publicli": 5, "publish": 10, "purpos": 10, "pwa": [0, 6], "pypi": 7, "python": [1, 7, 8, 9], "pyworldatla": [0, 2, 4, 6, 11], "queri": 11, "question": 5, "quick": 11, "quickli": 5, "rais": 0, "rang": [0, 5, 9], "re": [9, 10], "reach": 2, "recommend": 8, "refer": [5, 6, 7], "refin": [1, 11], "reflect": 11, "regard": 11, "relat": 9, "releas": 1, "reli": 5, "reliabl": [9, 11], "religion": 9, "remain": 11, "report": [2, 7], "repositori": 7, "represent": 11, "republ": 1, "request": 2, "requir": [1, 7, 9, 11], "resourc": 5, "restrict": 10, "retriev": [0, 5, 6, 7, 9, 11], "return": [0, 6], "revis": [1, 5, 11], "right": [0, 6, 9, 10], "roadmap": [0, 7], "run": [6, 8, 9], "said": 10, "save": 1, "scientist": 9, "seamlessli": 9, "section": 0, "see": [7, 10], "sell": 10, "separ": 4, "seriou": 10, "sever": 0, "sha": 4, "sha256": 4, "sha256sum": 4, "shall": 10, "ship": [1, 5], "short": 11, "should": 8, "shown": 3, "side": 6, "simpl": [0, 5, 6, 8], "simpli": [8, 9], "simplic": 9, "singl": 9, "size": [0, 4], "smaller": 1, "so": [4, 5, 10], "softwar": 10, "some": 5, "someth": 6, "soon": 5, "sourc": [1, 7], "spain": 0, "specif": [0, 6], "specifi": 6, "sqlite": 5, "sqlite3": [4, 5], "stabl": 2, "stai": [2, 11], "standard": [2, 5], "start": [7, 8, 9], "state": [2, 6], "statist": [5, 7, 9], "steadi": 11, "step": [6, 7], "store": 5, "str": 0, "straightforward": 6, "stronger": 1, "structur": 5, "stuff": 10, "subject": [5, 10], "sublicens": 10, "substanti": 10, "success": 8, "successfulli": 8, "suggest": 7, "support": 1, "system": [4, 8], "t": 6, "take": 11, "target": 11, "term": [1, 11], "test": 1, "thank": [2, 11], "thi": [0, 2, 3, 4, 5, 6, 8, 10, 11], "though": 11, "throughout": 0, "throw": 10, "time": [1, 2, 11], "timezon": 9, "tool": 9, "tort": 10, "total": 0, "toward": 11, "tox": 1, "track": 1, "tracker": [2, 5, 7], "transpar": 5, "true": 0, "try": 0, "tune": [2, 11], "u": 6, "uncompress": 4, "under": [7, 10], "understand": [2, 11], "uniqu": 1, "unit": 6, "unless": 4, "up": [2, 5, 6, 9], "upcom": 0, "updat": [1, 2, 11], "us": [1, 2, 6, 7, 8, 9, 10], "usabl": 11, "usag": [0, 7], "user": 5, "vari": 11, "verifi": 7, "version": [1, 4, 7, 8], "versu": 11, "via": 2, "visit": 5, "visual": 11, "wa": [5, 8], "want": [4, 11], "warranti": 10, "washington": 6, "we": 0, "web": 9, "week": 11, "welcom": [5, 9], "what": 7, "when": [0, 4], "where": 7, "whether": [9, 10], "which": 5, "while": 11, "who": 7, "whom": 10, "wide": [5, 9], "wikipedia": [1, 5, 11], "window": 4, "wip": 7, "wish": 10, "without": [5, 9, 10], "work": [7, 9], "world": 9, "worldatla": [4, 5], "yet": 3, "york": 6, "you": [2, 4, 5, 6, 8, 9, 10, 11], "your": [2, 4, 8]}, "titles": ["API Reference", "Changelog", "Contributing", "Country Data", "Database Download", "FAQ", "Getting Started", "Welcome to pyworldatlas\u2019s Documentation", "Installation", "Introduction", "License", "Roadmap"], "titleterms": {"": [6, 7], "0": 1, "08": 1, "16": 1, "19": 1, "20": 1, "2024": 1, "24": 1, "3": 1, "4": 1, "5": 1, "6": 1, "7": 1, "addit": 0, "an": 5, "ani": 5, "api": 0, "approach": 11, "area": 11, "atla": 0, "basic": 6, "benefit": 9, "can": 5, "changelog": 1, "class": 0, "collect": 11, "connect": 5, "content": 7, "contribut": [2, 7], "countri": [3, 5, 6], "countrynotfounderror": 0, "data": [3, 5, 11], "databas": [3, 4], "depend": 5, "detail": 4, "do": 5, "document": 7, "doe": 5, "download": 4, "each": 5, "ensur": 5, "error": 0, "exampl": 6, "extern": 5, "faq": 5, "featur": [0, 5, 7], "fetch": 6, "file": 4, "focu": 11, "from": 5, "futur": 11, "get": [5, 6], "get_countri": 0, "get_country_profil": 0, "get_progress": 0, "goal": 11, "handl": 0, "how": 5, "i": [5, 9], "instal": 8, "internet": 5, "introduct": 9, "issu": 5, "its": 5, "kei": [7, 9], "librari": 5, "licens": [7, 10], "link": [4, 7], "method": 0, "minimum": 5, "mit": 10, "neutral": 5, "next": [6, 8, 9], "output": 6, "plan": 11, "polit": 5, "prerequisit": 6, "profil": 6, "python": 5, "pyworldatla": [3, 5, 7, 8, 9], "quick": 7, "refer": 0, "report": 5, "requir": [5, 8], "roadmap": 11, "sourc": 5, "start": 6, "step": [8, 9], "suggest": 5, "us": 5, "usag": 6, "verifi": [4, 5, 8], "version": 5, "welcom": 7, "what": [5, 6, 9], "where": 5, "who": 9, "wip": 0, "work": 5}}) \ No newline at end of file +Search.setIndex({"alltitles": {"0.0.3 - 2024-08-16": [[1, "id5"]], "0.0.4 - 2024-08-19": [[1, "id4"]], "0.0.5 - 2024-08-19": [[1, "id3"]], "0.0.6 - 2024-08-20": [[1, "id2"]], "0.0.7 - 2024-08-24": [[1, "id1"]], "API Reference": [[0, null]], "Additional Features": [[0, "additional-features"]], "Atlas Class": [[0, "atlas-class"]], "Basic Usage": [[6, "basic-usage"]], "Changelog": [[1, null]], "Classes and Methods": [[0, "classes-and-methods"]], "Contents:": [[7, null]], "Contributing": [[2, null], [7, "contributing"]], "Countries in pyworldatlas Database": [[3, "id1"]], "Country Data": [[3, null]], "CountryNotFoundError": [[0, "countrynotfounderror"]], "Data Collection Approach": [[11, "data-collection-approach"]], "Database Download": [[4, null]], "Does pyworldatlas depend on any external libraries?": [[5, "does-pyworldatlas-depend-on-any-external-libraries"]], "Does pyworldatlas require an internet connection to work?": [[5, "does-pyworldatlas-require-an-internet-connection-to-work"]], "Download Link": [[4, "download-link"]], "Error Handling": [[0, "error-handling"]], "Example Output": [[6, "example-output"]], "Example: Fetching a Country\u2019s Profile": [[6, "example-fetching-a-country-s-profile"]], "FAQ": [[5, null]], "File Details": [[4, "file-details"]], "Future Plans": [[11, "future-plans"]], "Getting Started": [[6, null]], "Goals and Focus Areas": [[11, "goals-and-focus-areas"]], "How can I verify the source of the data for each country?": [[5, "how-can-i-verify-the-source-of-the-data-for-each-country"]], "How do I report an issue or suggest a feature?": [[5, "how-do-i-report-an-issue-or-suggest-a-feature"]], "How does pyworldatlas ensure political neutrality?": [[5, "how-does-pyworldatlas-ensure-political-neutrality"]], "Installation": [[8, null]], "Installing pyworldatlas": [[8, "installing-pyworldatlas"]], "Introduction": [[9, null]], "Key Benefits": [[9, "key-benefits"]], "Key Features": [[7, "key-features"]], "License": [[7, "license"], [10, null]], "MIT License": [[10, "mit-license"]], "Next Steps": [[8, "next-steps"], [9, "next-steps"]], "Prerequisites": [[6, "prerequisites"]], "Quick Links": [[7, "quick-links"]], "Requirements": [[8, "requirements"]], "Roadmap": [[11, null]], "Verifying Installation": [[8, "verifying-installation"]], "Verifying the File": [[4, "verifying-the-file"]], "Welcome to pyworldatlas\u2019s Documentation": [[7, null]], "What Next?": [[6, "what-next"]], "What data can I get from pyworldatlas?": [[5, "what-data-can-i-get-from-pyworldatlas"]], "What is pyworldatlas?": [[9, "what-is-pyworldatlas"]], "What is the minimum Python version required to use pyworldatlas?": [[5, "what-is-the-minimum-python-version-required-to-use-pyworldatlas"]], "Where does pyworldatlas source its data from?": [[5, "where-does-pyworldatlas-source-its-data-from"]], "Who is it for?": [[9, "who-is-it-for"]], "get_countries (WIP)": [[0, "get-countries-wip"]], "get_country_profile": [[0, "get-country-profile"]], "get_progress": [[0, "get-progress"]]}, "docnames": ["api_reference", "changelog", "contributing", "country_data", "database_download", "faq", "getting_started", "index", "installation", "introduction", "license", "roadmap"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["api_reference.rst", "changelog.rst", "contributing.rst", "country_data.rst", "database_download.rst", "faq.rst", "getting_started.rst", "index.rst", "installation.rst", "introduction.rst", "license.rst", "roadmap.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 5, 10, 11], "0": 7, "0060": 6, "0369": 6, "08": 7, "1": [0, 6, 11], "10": 4, "1000000": 0, "16": 7, "19": 7, "1fd820212aa6cbc3f07ab32c3a4db3b7f683c1101a80a7649ddcf2fdf0aa7bd0": 4, "2": [0, 11], "20": 7, "2024": [7, 10], "24": 7, "256": 4, "285": 0, "288": 4, "2e8b9594da57e0e80f0a692530136dffb06d631375a159ea1bd242642d837760": 4, "3": [0, 5, 7, 8], "3166": [0, 3], "33": 0, "35": 1, "3522": 0, "38": 6, "4": 7, "40": 6, "48": 0, "5": [7, 11], "6": 7, "7": 7, "7128": 6, "74": 6, "77": 6, "8": [1, 5, 8], "8566": 0, "9": [5, 8], "9072": 6, "A": [0, 5, 10], "AND": 10, "AS": 10, "As": 11, "At": 2, "BE": 10, "BUT": 10, "FOR": 10, "For": [5, 8, 10], "IN": 10, "If": [3, 5, 6], "In": [2, 6], "It": [0, 5], "NO": 10, "NOT": 10, "No": [5, 7, 9], "OF": 10, "OR": 10, "THE": 10, "TO": 10, "That": 10, "The": [0, 2, 4, 5, 6, 9, 10, 11], "Then": 6, "To": [4, 6, 8, 9], "WITH": 10, "With": 6, "__version__": 8, "abl": [1, 6], "about": [0, 4, 5, 6, 7, 9, 11], "abov": 10, "accept": 2, "access": [0, 4, 6, 7, 9, 11], "accordingli": 1, "accur": [5, 9, 11], "action": 10, "actual": 11, "ad": [1, 3, 11], "add": 11, "addit": [5, 7, 11], "af": 3, "afghanistan": [1, 3], "aim": [5, 11], "al": 3, "albania": [1, 3], "algeria": [1, 3], "algorithm": 4, "all": [3, 4, 5, 10], "allow": 5, "alpha": 0, "alreadi": 6, "altern": 8, "alwai": [5, 11], "am": 2, "an": [6, 7, 9, 10], "analysi": 9, "ani": [2, 6, 7, 9, 10], "anyon": 9, "api": [5, 6, 7], "applic": 9, "approach": [1, 7], "ar": [1, 5, 9], "area": [0, 7], "aris": 10, "around": 11, "arrai": 9, "articl": [5, 11], "asia": 0, "ask": 5, "associ": 10, "assum": 0, "atla": [6, 7], "attribut": 10, "author": 10, "autom": 11, "automat": 8, "avail": [0, 3, 4, 5, 6, 8, 11], "avoid": 5, "bar": 11, "base": 1, "basic": [1, 7], "becaus": [10, 11], "been": [0, 8], "befor": [2, 6], "begin": [6, 9], "behav": 1, "being": 10, "below": [3, 4, 5, 6, 7, 10, 11], "benefit": 7, "best": 5, "better": 1, "build": [9, 11], "built": 5, "bump": 1, "c": [6, 10], "call": [5, 6], "calling_cod": [0, 6], "can": [4, 6, 7, 8], "capit": [0, 5, 6], "care": 11, "carefulli": 11, "caridad": 10, "changelog": 7, "charg": 10, "check": [5, 6, 8], "citi": [0, 1, 5, 6], "claim": 10, "class": [6, 7], "cli": 1, "code": [0, 2, 3, 10], "collabor": 2, "collect": 7, "command": [1, 4, 8], "compar": 11, "compil": [4, 5, 7, 9, 11], "complet": [0, 1, 2, 11], "complex": 11, "comprehens": [6, 9, 11], "compress": 4, "condit": 10, "confirm": 8, "connect": [7, 10], "consid": 11, "consist": 11, "contain": [0, 4, 6], "contin": [0, 1], "continu": 0, "contract": 10, "contribut": [5, 11], "conveni": 5, "coordin": 1, "coordinates_degree_east": [0, 6], "coordinates_degree_north": [0, 6], "copi": 10, "copyright": 10, "core": 11, "countri": [0, 1, 4, 7, 9, 11], "countrynotfounderror": 7, "cover": 9, "coverag": 11, "creat": [5, 6], "criteria": 0, "curat": 11, "currenc": 9, "current": [0, 3, 4, 8, 11], "custom": 0, "d": 6, "damag": 10, "data": [0, 1, 6, 7, 9], "databas": [1, 5, 7, 11], "dataset": [0, 1, 11], "date": [5, 9], "daylight": 1, "de": 1, "deal": 10, "decompress": 1, "deeper": 11, "default": 4, "depend": [4, 7, 9, 11], "deprec": 1, "design": [0, 5, 9], "detail": [0, 2, 6, 7, 9], "develop": [9, 11], "dict": 0, "dictionari": [0, 6], "differ": 1, "displai": [6, 8], "distribut": 10, "do": [7, 10], "document": [1, 10, 11], "doe": [7, 11], "done": [4, 11], "download": [1, 7], "drive": 6, "driving_sid": [0, 6], "dst": 1, "dz": 3, "e": [0, 1], "each": [0, 1, 7, 11], "earlier": 1, "easi": [7, 9], "easili": 9, "econom": [5, 9], "effici": [0, 7, 9], "either": 8, "encount": 5, "enhanc": [1, 11], "ensur": [1, 4, 6, 7, 11], "environ": 8, "error": 7, "especi": 11, "ethnic": 9, "europ": 0, "event": 10, "everi": [7, 9], "everyth": 5, "evolv": [0, 11], "exact": 5, "exampl": [0, 7], "except": 0, "expand": [1, 11], "expect": 11, "explor": [6, 9], "express": 10, "extens": 7, "extern": [2, 7, 9], "facilit": 1, "fals": 6, "faq": 7, "fast": [7, 9], "featur": [2, 6, 11], "feedback": 2, "feel": [2, 5], "fetch": [0, 7], "few": 6, "field": 1, "file": [7, 10], "filehash": 4, "filter": 0, "final": 1, "finish": 1, "fit": 10, "fix": 1, "flexibl": 9, "float": 0, "focu": [5, 7], "follow": [1, 4, 7, 8, 9, 10, 11], "footprint": 9, "format": 11, "found": 0, "foundat": 6, "fr": 0, "fragment": 1, "franc": 0, "free": [2, 5, 10], "frequent": 5, "from": [4, 7, 10], "full": 5, "fulli": 2, "furnish": 10, "further": 11, "futur": 7, "g": [0, 1], "gdp": [0, 5, 7, 9], "geograph": 9, "geographi": [5, 7], "germani": 0, "get": [4, 7, 8, 9], "get_countri": 7, "get_country_profil": [1, 6, 7], "get_progress": 7, "gini": 9, "github": [2, 5, 7], "given": 10, "global": [9, 11], "goal": [2, 5, 7], "good": 10, "govern": [0, 5, 7, 9], "grant": 10, "graph": 11, "group": 9, "growth": 11, "guess": 10, "guid": [6, 7, 8, 9], "guidelin": 2, "gz": 4, "gzip": [1, 4], "ha": [0, 8, 9], "handl": [5, 7], "hash": 4, "hassl": 9, "have": [5, 6, 10], "haven": 6, "help": [0, 6], "here": 6, "herebi": 10, "higher": 5, "holder": 10, "how": [7, 8], "howev": [5, 11], "i": [0, 1, 2, 3, 4, 6, 7, 8, 10, 11], "id": [1, 5, 11], "identifi": 0, "implement": 11, "impli": 10, "import": [0, 6, 8], "improv": [0, 11], "includ": [2, 4, 5, 6, 7, 9, 10], "incorpor": 1, "index": 9, "indic": 3, "inform": [0, 3, 4, 5, 6, 7, 9, 11], "initi": 1, "instal": [4, 6, 7, 9], "instanc": 6, "instruct": 7, "integr": [4, 7, 9], "interest": [2, 9], "interfac": [0, 6], "intern": 5, "internet": 7, "internet_tld": [0, 6], "interpret": 8, "introduc": [1, 11], "introduct": 7, "intuit": 0, "is_largest_c": [0, 6], "iso": [0, 3], "iso_3166_cod": [0, 6], "issu": [2, 7], "itali": 0, "its": [3, 6, 7], "jorg": 10, "jump": 9, "just": [6, 9], "kb": 4, "kind": 10, "languag": [1, 9], "largest": [0, 1, 5, 6], "largest_c": 6, "last_upd": 1, "latest": 4, "leader": 1, "learn": [8, 11], "let": 10, "level": 9, "liabil": 10, "liabl": 10, "librari": 7, "lightweight": [5, 7, 9], "like": [5, 6], "limit": 10, "line": 8, "linux": 4, "list": [0, 3, 5, 6], "ll": 6, "local": 5, "long": 10, "look": [6, 10], "lot": 1, "mac": 4, "mai": 11, "main": [0, 5], "make": [7, 8], "mani": 1, "manual": [4, 5, 11], "match": 0, "max_gdp": 0, "max_popul": 0, "maximum": [0, 5, 8], "me": 11, "mean": 10, "meantim": 2, "merchant": 10, "merg": 10, "method": [1, 5, 6, 7, 8, 9, 11], "mid": 11, "min_gdp": 0, "min_popul": 0, "mind": 9, "minim": 9, "minimum": [0, 7], "minist": 1, "mit": 7, "model": 1, "modifi": 10, "more": [0, 1, 5, 6, 7, 9], "much": 9, "name": [0, 1, 5, 6, 7, 9], "nearing": 11, "need": [1, 5, 9], "needs_upd": 1, "neutral": 7, "new": [5, 6, 11], "next": 7, "nonexistentland": 0, "noninfring": 10, "notic": 10, "now": 1, "number": 11, "object": 5, "obtain": 10, "offer": [7, 9], "offic": 1, "offici": [0, 1, 5, 7, 9], "onc": [2, 6, 8, 11], "ongo": 11, "open": [2, 11], "oper": 4, "opinion": 5, "opportun": 11, "optim": 11, "option": [0, 4, 6], "other": [0, 1, 6, 10], "otherwis": [3, 10], "our": 5, "out": [6, 10], "output": [0, 7], "overview": 0, "packag": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11], "page": [1, 3, 7, 9, 10], "paramet": 0, "pari": 0, "particular": 10, "per": 11, "percentag": 0, "perform": [5, 8, 9, 11], "period": 11, "permiss": 10, "permit": 10, "person": [2, 9, 10, 11], "pip": 8, "plan": 7, "pleas": [5, 7], "polish": 1, "polit": 7, "popul": [0, 5, 7, 9], "portion": 10, "powershel": 4, "prerequisit": 7, "present": 3, "presid": 1, "primarili": 5, "prime": 1, "print": [0, 6, 8], "prior": 1, "prioriti": 11, "proce": 8, "process": 11, "profil": [0, 1, 5, 7, 9], "progress": [0, 11], "project": [2, 7, 9, 10], "properli": 5, "provid": [0, 2, 5, 6, 9, 10, 11], "publicli": 5, "publish": 10, "purpos": 10, "pwa": [0, 6], "pypi": 7, "python": [1, 7, 8, 9], "pyworldatla": [0, 2, 4, 6, 11], "queri": 11, "question": 5, "quick": 11, "quickli": 5, "rais": 0, "rang": [0, 5, 9], "re": [9, 10], "reach": 2, "recommend": 8, "refer": [5, 6, 7], "refin": [1, 11], "reflect": 11, "regard": 11, "relat": 9, "releas": 1, "reli": 5, "reliabl": [9, 11], "religion": 9, "remain": 11, "report": [2, 7], "repositori": 7, "represent": 11, "republ": 1, "request": 2, "requir": [1, 7, 9, 11], "resourc": 5, "restrict": 10, "retriev": [0, 5, 6, 7, 9, 11], "return": [0, 6], "revis": [1, 5, 11], "right": [0, 6, 9, 10], "roadmap": [0, 7], "run": [6, 8, 9], "said": 10, "save": 1, "scientist": 9, "seamlessli": 9, "section": 0, "see": [7, 10], "sell": 10, "separ": 4, "seriou": 10, "sever": 0, "sha": 4, "sha256": 4, "sha256sum": 4, "shall": 10, "ship": [1, 5], "short": 11, "should": 8, "shown": 3, "side": 6, "simpl": [0, 5, 6, 8], "simpli": [8, 9], "simplic": 9, "singl": 9, "size": [0, 4], "smaller": 1, "so": [4, 5, 10], "softwar": 10, "some": 5, "someth": 6, "soon": 5, "sourc": [1, 7], "spain": 0, "specif": [0, 6], "specifi": 6, "sqlite": 5, "sqlite3": [4, 5], "stabl": 2, "stai": [2, 11], "standard": [2, 5], "start": [7, 8, 9], "state": [2, 6], "statist": [5, 7, 9], "steadi": 11, "step": [6, 7], "store": 5, "str": 0, "straightforward": 6, "stronger": 1, "structur": 5, "stuff": 10, "subject": [5, 10], "sublicens": 10, "substanti": 10, "success": 8, "successfulli": 8, "suggest": 7, "support": 1, "system": [4, 8], "t": 6, "take": 11, "target": 11, "term": [1, 11], "test": 1, "thank": [2, 11], "thi": [0, 2, 3, 4, 5, 6, 8, 10, 11], "though": 11, "throughout": 0, "throw": 10, "time": [1, 2, 11], "timezon": 9, "tool": 9, "tort": 10, "total": 0, "toward": 11, "tox": 1, "track": 1, "tracker": [2, 5, 7], "transpar": 5, "true": 0, "try": 0, "tune": [2, 11], "u": 6, "uncompress": 4, "under": [7, 10], "understand": [2, 11], "uniqu": 1, "unit": 6, "unless": 4, "up": [2, 5, 6, 9], "upcom": 0, "updat": [1, 2, 11], "us": [1, 2, 6, 7, 8, 9, 10], "usabl": 11, "usag": [0, 7], "user": 5, "vari": 11, "verifi": 7, "version": [1, 4, 7, 8], "versu": 11, "via": 2, "visit": 5, "visual": 11, "wa": [5, 8], "want": [4, 11], "warranti": 10, "washington": 6, "we": 0, "web": 9, "week": 11, "welcom": [5, 9], "what": 7, "when": [0, 4], "where": 7, "whether": [9, 10], "which": 5, "while": 11, "who": 7, "whom": 10, "wide": [5, 9], "wikipedia": [1, 5, 11], "window": 4, "wip": 7, "wish": 10, "without": [5, 9, 10], "work": [7, 9], "world": 9, "worldatla": [4, 5], "yet": 3, "york": 6, "you": [2, 4, 5, 6, 8, 9, 10, 11], "your": [2, 4, 8]}, "titles": ["API Reference", "Changelog", "Contributing", "Country Data", "Database Download", "FAQ", "Getting Started", "Welcome to pyworldatlas\u2019s Documentation", "Installation", "Introduction", "License", "Roadmap"], "titleterms": {"": [6, 7], "0": 1, "08": 1, "16": 1, "19": 1, "20": 1, "2024": 1, "24": 1, "3": 1, "4": 1, "5": 1, "6": 1, "7": 1, "addit": 0, "an": 5, "ani": 5, "api": 0, "approach": 11, "area": 11, "atla": 0, "basic": 6, "benefit": 9, "can": 5, "changelog": 1, "class": 0, "collect": 11, "connect": 5, "content": 7, "contribut": [2, 7], "countri": [3, 5, 6], "countrynotfounderror": 0, "data": [3, 5, 11], "databas": [3, 4], "depend": 5, "detail": 4, "do": 5, "document": 7, "doe": 5, "download": 4, "each": 5, "ensur": 5, "error": 0, "exampl": 6, "extern": 5, "faq": 5, "featur": [0, 5, 7], "fetch": 6, "file": 4, "focu": 11, "from": 5, "futur": 11, "get": [5, 6], "get_countri": 0, "get_country_profil": 0, "get_progress": 0, "goal": 11, "handl": 0, "how": 5, "i": [5, 9], "instal": 8, "internet": 5, "introduct": 9, "issu": 5, "its": 5, "kei": [7, 9], "librari": 5, "licens": [7, 10], "link": [4, 7], "method": 0, "minimum": 5, "mit": 10, "neutral": 5, "next": [6, 8, 9], "output": 6, "plan": 11, "polit": 5, "prerequisit": 6, "profil": 6, "python": 5, "pyworldatla": [3, 5, 7, 8, 9], "quick": 7, "refer": 0, "report": 5, "requir": [5, 8], "roadmap": 11, "sourc": 5, "start": 6, "step": [8, 9], "suggest": 5, "us": 5, "usag": 6, "verifi": [4, 5, 8], "version": 5, "welcom": 7, "what": [5, 6, 9], "where": 5, "who": 9, "wip": 0, "work": 5}}) \ No newline at end of file