-
Notifications
You must be signed in to change notification settings - Fork 0
/
introduction.html
159 lines (139 loc) · 8.29 KB
/
introduction.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
<!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>Introduction — 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="Installation" href="installation.html" />
<link rel="prev" title="Welcome to pyworldatlas’s Documentation" href="index.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 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-pyworldatlas">What is pyworldatlas?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#key-benefits">Key Benefits</a></li>
<li class="toctree-l2"><a class="reference internal" href="#who-is-it-for">Who is it for?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#next-steps">Next Steps</a></li>
</ul>
</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="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">Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/introduction.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="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h1>
<p>Welcome to <strong>pyworldatlas</strong>, a Python package designed to provide comprehensive data about every country in the world. Whether you are building an application that requires detailed country profiles, or you simply need to access accurate and up-to-date information on global statistics, pyworldatlas has you covered.</p>
<section id="what-is-pyworldatlas">
<h2>What is pyworldatlas?<a class="headerlink" href="#what-is-pyworldatlas" title="Link to this heading"></a></h2>
<p><strong>pyworldatlas</strong> is a lightweight, efficient, and easy-to-use Python package that compiles a wide range of data on countries. The package is designed with simplicity in mind, offering methods to retrieve detailed country profiles that include:</p>
<ul class="simple">
<li><p>Official names</p></li>
<li><p>Population statistics</p></li>
<li><p>Geographic information</p></li>
<li><p>Government details</p></li>
<li><p>Economic data (GDP, Gini Index)</p></li>
<li><p>Ethnic groups, religions, and languages</p></li>
<li><p>Timezones, currencies, and much more</p></li>
</ul>
</section>
<section id="key-benefits">
<h2>Key Benefits<a class="headerlink" href="#key-benefits" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><strong>No external dependencies</strong>: Easily install and use without any hassle.</p></li>
<li><p><strong>Lightweight and fast</strong>: Minimal footprint with efficient performance.</p></li>
<li><p><strong>Comprehensive</strong>: Covers a wide array of country-related data in a single package.</p></li>
<li><p><strong>Easy to integrate</strong>: Works seamlessly in any Python project, whether you’re building applications, performing data analysis, or just exploring global data.</p></li>
</ul>
</section>
<section id="who-is-it-for">
<h2>Who is it for?<a class="headerlink" href="#who-is-it-for" title="Link to this heading"></a></h2>
<p><strong>pyworldatlas</strong> is designed for developers, data scientists, and anyone interested in accessing detailed country-level data for their projects. Whether you’re building a web application, running data analysis, or working on personal projects, pyworldatlas offers a flexible and reliable tool for working with global data.</p>
</section>
<section id="next-steps">
<h2>Next Steps<a class="headerlink" href="#next-steps" title="Link to this heading"></a></h2>
<p>To start using pyworldatlas, follow the <a class="reference external" href="installation.html">Installation</a> guide or jump right into the <a class="reference external" href="getting_started.html">Getting Started</a> page to begin working with the package.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to pyworldatlas’s Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" 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>