diff --git a/README.rst b/README.rst index e4f6549..c38e1ed 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,5 @@ -.. raw:: html - -

- header -

- -

pyGAUL

+pyGAUL +====== .. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white :target: LICENSE @@ -49,14 +44,14 @@ Overview -------- +.. image:: docs/_static/logo.svg + :width: 20% + :align: right + Easy access to administrative boundary defined by FAO GAUL 2015 from Python scripts. This lib provides access to FAO GAUL 2015 datasets from a Python script. it is the best boundary dataset available for GEE at this point. We provide access to The current version (2015) administrative areas till level 2. -.. note:: - - the dataset was generated in 2015 by the Food and Alimentation Organization (FAO). It has not been updated on Google Earthengine since then. Use with caution on disputed territories. - install it using either ``pip`` or ``conda``: .. code-block:: console @@ -71,6 +66,11 @@ and then request area of interest from their name or GADM Id: gdf = pygaul.Items(name="Singapore", content_level=1) +Note +---- + +the dataset was generated in 2015 by the Food and Alimentation Organization (FAO). It has not been updated on Google Earthengine since then. Use with caution on disputed territories. + Credits ------- diff --git a/docs/_static/logo.svg b/docs/_static/logo.svg new file mode 100644 index 0000000..1381f7d --- /dev/null +++ b/docs/_static/logo.svg @@ -0,0 +1,5414 @@ + + + + diff --git a/pyproject.toml b/pyproject.toml index 76917e1..80bda01 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -124,4 +124,4 @@ warn_redundant_casts = true using = "PEP631:test;dev;doc" [tool.codespell] -skip = "./pygaul/data/gaul_continent.json,**/*.csv" +skip = "./pygaul/data/gaul_continent.json,**/*.csv,**/*.svg"