-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathroadmap.html
152 lines (132 loc) · 8.15 KB
/
roadmap.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
<!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>Roadmap — 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="Changelog" href="changelog.html" />
<link rel="prev" title="Contributing" href="contributing.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"><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 current"><a class="current reference internal" href="#">Roadmap</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#data-collection-approach">Data Collection Approach</a></li>
<li class="toctree-l2"><a class="reference internal" href="#goals-and-focus-areas">Goals and Focus Areas</a></li>
<li class="toctree-l2"><a class="reference internal" href="#future-plans">Future Plans</a></li>
</ul>
</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">Roadmap</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/roadmap.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="roadmap">
<h1>Roadmap<a class="headerlink" href="#roadmap" title="Link to this heading"></a></h1>
<p>The development of <strong>pyworldatlas</strong> is ongoing, with a focus on building a comprehensive and reliable package of country data. Below is the current plan for the package’s growth.</p>
<section id="data-collection-approach">
<h2>Data Collection Approach<a class="headerlink" href="#data-collection-approach" title="Link to this heading"></a></h2>
<p>The data collection for <strong>pyworldatlas</strong> is done manually. This process is not automated because I want to take the time to personally learn about each country. This ensures that the data is carefully curated and accurate while providing me with a deeper understanding of global information.</p>
</section>
<section id="goals-and-focus-areas">
<h2>Goals and Focus Areas<a class="headerlink" href="#goals-and-focus-areas" title="Link to this heading"></a></h2>
<p><strong>Data Collection</strong>
- <strong>Ongoing</strong>: Adding new countries to the database. The aim is to add around 5 countries per week, though this may vary depending on the complexity and availability of data. Each country requires careful compilation, as information does not always follow a consistent format.
- <strong>Target</strong>: Aim for steady progress toward complete global coverage.</p>
<p><strong>Package Core Enhancements</strong>
- <strong>Ongoing</strong>: Improve and refine the core methods for retrieving and processing country data.
- <strong>Short-Term</strong>: Implement a quick access method for retrieving the Wikipedia article revision ID for each country.
- <strong>Mid-Term</strong>: Further optimize performance, especially regarding database queries.</p>
<p><strong>Progress Visualization</strong>
- <strong>Planned</strong>: Introduce a visual representation of package progress, such as a bar or graph comparing the expected number of countries to be added versus the actual number of countries in the database. This will be updated periodically to reflect the progress.</p>
</section>
<section id="future-plans">
<h2>Future Plans<a class="headerlink" href="#future-plans" title="Link to this heading"></a></h2>
<p>As the package evolves, there may be opportunities to introduce additional features and optimizations. However, the current priority remains:
1. <strong>Completing the country dataset</strong>.
2. <strong>Improving the performance and usability of the package</strong>.</p>
<p>Once the dataset is nearing completion, additional goals such as opening the package for contributions and expanding the documentation will be considered.</p>
<p>Thank you for following the development of <strong>pyworldatlas</strong>. Stay tuned for updates!</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="changelog.html" class="btn btn-neutral float-right" title="Changelog" 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>