.. _reference:


API reference
=============

The ``geodatasets`` package has top-level functions that will cover 95% of use cases and
other tooling handling the database.

Top-level API
-------------

In most cases, you will be using :func:`~geodatasets.get_path` to download the data and get the path
to the local storage, :func:`~geodatasets.get_url` to get the link to the original dataset in its
online location and :func:`~geodatasets.fetch` to pre-download data to the local storage.

.. currentmodule:: geodatasets

.. autofunction:: get_path

.. autofunction:: get_url

.. autofunction:: fetch

Database-level API
------------------

The database of dataset metadata is handled via custom dict-based classes.

.. autoclass:: Dataset
   :members: path

   A dict with attribute-access and that can be called to update keys.

.. autoclass:: Bunch
   :exclude-members: clear, copy, fromkeys, get, items, keys, pop, popitem, setdefault, update, values
   :members: filter, flatten, query_name