README.md 3.2 KB

FAOSTAT data

Download and process FAOSTAT data

CI Coverage Docs

PyPI : PyPI PyPI install

Other info : Licence Last Commit Contributors

Full documentation can be found at: faostat-data-primap.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.

Installation

FAOSTAT data can be installed with pip, mamba or conda:

pip install faostat-data-primap
mamba install -c conda-forge faostat-data-primap
conda install -c conda-forge faostat-data-primap

For developers

For development, we rely on poetry for all our dependency management. To get started, you will need to make sure that poetry is installed (instructions here, we found that pipx and pip worked better to install on a Mac).

For all of work, we use our Makefile. You can read the instructions out and run the commands by hand if you wish, but we generally discourage this because it can be error prone. In order to create your environment, run make virtual-environment.

If there are any issues, the messages from the Makefile should guide you through. If not, please raise an issue in the issue tracker.

For the rest of our developer docs, please see [](development-reference).