-
Notifications
You must be signed in to change notification settings - Fork 0
/
faq.html
165 lines (145 loc) · 10.9 KB
/
faq.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
<!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>FAQ — 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="Contributing" href="contributing.html" />
<link rel="prev" title="Database Download" href="database_download.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="index.html" 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 class="current">
<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 current"><a class="current reference internal" href="#">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#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="#how-does-pyworldatlas-ensure-political-neutrality">How does pyworldatlas ensure political neutrality?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#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="#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="#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="#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="#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="#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></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="index.html">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="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">FAQ</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/faq.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="faq">
<h1>FAQ<a class="headerlink" href="#faq" title="Link to this heading"></a></h1>
<p>Below are some frequently asked questions about <strong>pyworldatlas</strong>. If you have any additional questions, feel free to check the <a class="reference external" href="https://github.com/yourrepo/pyworldatlas/issues">GitHub Issue Tracker</a>.</p>
<section id="does-pyworldatlas-require-an-internet-connection-to-work">
<h2>Does pyworldatlas require an internet connection to work?<a class="headerlink" href="#does-pyworldatlas-require-an-internet-connection-to-work" title="Link to this heading"></a></h2>
<p>No, <strong>pyworldatlas</strong> ships with a built-in SQLite database called <cite>worldatlas.sqlite3</cite>, so all the data is stored locally. This ensures that you can use the package without needing an internet connection.</p>
</section>
<section id="how-does-pyworldatlas-ensure-political-neutrality">
<h2>How does pyworldatlas ensure political neutrality?<a class="headerlink" href="#how-does-pyworldatlas-ensure-political-neutrality" title="Link to this heading"></a></h2>
<p>The data compiled by <strong>pyworldatlas</strong> aims to be politically neutral. I rely on publicly available sources and focus on objective data like official country names, population, geography, and economic statistics. I avoid any subjective or political opinions.</p>
</section>
<section id="what-is-the-minimum-python-version-required-to-use-pyworldatlas">
<h2>What is the minimum Python version required to use pyworldatlas?<a class="headerlink" href="#what-is-the-minimum-python-version-required-to-use-pyworldatlas" title="Link to this heading"></a></h2>
<p><strong>pyworldatlas</strong> requires Python 3.8 or higher to work properly. However, Python 3.9 is best for maximum performance.</p>
</section>
<section id="does-pyworldatlas-depend-on-any-external-libraries">
<h2>Does pyworldatlas depend on any external libraries?<a class="headerlink" href="#does-pyworldatlas-depend-on-any-external-libraries" title="Link to this heading"></a></h2>
<p>No, <strong>pyworldatlas</strong> does not have any external dependencies. It is designed to be lightweight, with everything handled internally using Python’s standard libraries, such as SQLite.</p>
</section>
<section id="what-data-can-i-get-from-pyworldatlas">
<h2>What data can I get from pyworldatlas?<a class="headerlink" href="#what-data-can-i-get-from-pyworldatlas" title="Link to this heading"></a></h2>
<p><strong>pyworldatlas</strong> provides a wide range of data for each country, including official names, population, capital, largest city, GDP, government structure, and more. For a full list of available data, refer to the <a class="reference external" href="api_reference.html">API Reference</a>.</p>
</section>
<section id="where-does-pyworldatlas-source-its-data-from">
<h2>Where does pyworldatlas source its data from?<a class="headerlink" href="#where-does-pyworldatlas-source-its-data-from" title="Link to this heading"></a></h2>
<p>The data in <strong>pyworldatlas</strong> is manually compiled from publicly available resources, primarily sourced from the <a class="reference external" href="https://simple.wikipedia.org/wiki/List_of_countries">List of Countries on Wikipedia</a>. The goal is to ensure that the information provided is accurate and up to date.</p>
</section>
<section id="how-can-i-verify-the-source-of-the-data-for-each-country">
<h2>How can I verify the source of the data for each country?<a class="headerlink" href="#how-can-i-verify-the-source-of-the-data-for-each-country" title="Link to this heading"></a></h2>
<p>Each country’s profile in <strong>pyworldatlas</strong> includes the main Wikipedia article revision ID from which the information was sourced. This ensures transparency and allows users to verify the exact version of the data used. A method to quickly retrieve the revision ID will be available soon for convenience.</p>
</section>
<section id="how-do-i-report-an-issue-or-suggest-a-feature">
<h2>How do I report an issue or suggest a feature?<a class="headerlink" href="#how-do-i-report-an-issue-or-suggest-a-feature" title="Link to this heading"></a></h2>
<p>If you encounter any issues or have suggestions for new features, please visit our <a class="reference external" href="https://github.com/yourrepo/pyworldatlas/issues">GitHub Issue Tracker</a> and create a new issue. Contributions are always welcome!</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="database_download.html" class="btn btn-neutral float-left" title="Database Download" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" 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>