-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
227 lines (207 loc) · 14 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to pyworldatlas’s Documentation — pyworldatlas 0.0.8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="shortcut icon" href="_static/python.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=53b53b71"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="introduction.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
pyworldatlas
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="country_data.html">Country Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="database_download.html">Database Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">pyworldatlas</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to pyworldatlas’s Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-pyworldatlas-s-documentation">
<h1>Welcome to pyworldatlas’s Documentation<a class="headerlink" href="#welcome-to-pyworldatlas-s-documentation" title="Link to this heading"></a></h1>
<p><strong>pyworldatlas</strong> is a Python package that compiles detailed data about every country, offering easy-to-use methods for retrieving country profiles, statistics, and more.</p>
<section id="key-features">
<h2>Key Features<a class="headerlink" href="#key-features" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Extensive country data, including official names, population, geography, government details, GDP, and more.</p></li>
<li><p>Lightweight and efficient, ensuring fast access to country information.</p></li>
<li><p>No external dependencies, making it easy to install and integrate into any Python project.</p></li>
</ul>
<p>Get started by following the instructions below.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#what-is-pyworldatlas">What is pyworldatlas?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#key-benefits">Key Benefits</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#who-is-it-for">Who is it for?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#next-steps">Next Steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-pyworldatlas">Installing pyworldatlas</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#verifying-installation">Verifying Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#next-steps">Next Steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#basic-usage">Basic Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#example-fetching-a-country-s-profile">Example: Fetching a Country’s Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#example-output">Example Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#what-next">What Next?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#classes-and-methods">Classes and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#atlas-class">Atlas Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#get-country-profile">get_country_profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#get-countries-wip">get_countries (WIP)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#get-progress">get_progress</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#error-handling">Error Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#countrynotfounderror">CountryNotFoundError</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_reference.html#additional-features">Additional Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="country_data.html">Country Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="database_download.html">Database Download</a><ul>
<li class="toctree-l2"><a class="reference internal" href="database_download.html#download-link">Download Link</a></li>
<li class="toctree-l2"><a class="reference internal" href="database_download.html#file-details">File Details</a></li>
<li class="toctree-l2"><a class="reference internal" href="database_download.html#verifying-the-file">Verifying the File</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#does-pyworldatlas-require-an-internet-connection-to-work">Does pyworldatlas require an internet connection to work?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-does-pyworldatlas-ensure-political-neutrality">How does pyworldatlas ensure political neutrality?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-is-the-minimum-python-version-required-to-use-pyworldatlas">What is the minimum Python version required to use pyworldatlas?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#does-pyworldatlas-depend-on-any-external-libraries">Does pyworldatlas depend on any external libraries?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-data-can-i-get-from-pyworldatlas">What data can I get from pyworldatlas?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#where-does-pyworldatlas-source-its-data-from">Where does pyworldatlas source its data from?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-can-i-verify-the-source-of-the-data-for-each-country">How can I verify the source of the data for each country?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-report-an-issue-or-suggest-a-feature">How do I report an issue or suggest a feature?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a><ul>
<li class="toctree-l2"><a class="reference internal" href="roadmap.html#data-collection-approach">Data Collection Approach</a></li>
<li class="toctree-l2"><a class="reference internal" href="roadmap.html#goals-and-focus-areas">Goals and Focus Areas</a></li>
<li class="toctree-l2"><a class="reference internal" href="roadmap.html#future-plans">Future Plans</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">0.0.12 - 2024-09-25</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">0.0.11 - 2024-09-06</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">0.0.10 - 2024-08-25</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.0.9 - 2024-08-24</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">0.0.8 - 2024-08-24</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">0.0.7 - 2024-08-24</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.0.6 - 2024-08-20</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">0.0.5 - 2024-08-19</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">0.0.4 - 2024-08-19</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id10">0.0.3 - 2024-08-16</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">0.0.1 ~ 0.0.2 - 2024-08-16</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
<li class="toctree-l2"><a class="reference internal" href="license.html#mit-license">MIT License</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="quick-links">
<h2>Quick Links<a class="headerlink" href="#quick-links" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/jcari-dev/pyworldatlas-documentation">GitHub Repository</a></p></li>
<li><p><a class="reference external" href="https://github.com/jcari-dev/pyworldatlas-issue-tracker">Issue Tracker</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/pyworldatlas/">PyPI Page</a></p></li>
</ul>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"></a></h2>
<p>Please see the <a class="reference external" href="contributing.html">Contributing Page</a> for more details.</p>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
<p>pyworldatlas is licensed under the MIT License. See the <a class="reference external" href="license.html">License</a> for more information.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="introduction.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Jorge Caridad.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>