Skip to main content

Toolbox of functions and data types helping writing DBnomics fetchers.

Project description

dbnomics-fetcher-toolbox

Toolbox of functions and data types helping writing DBnomics fetchers.

Documentation Status

Installation

If you're using this package, you may be working on a DBnomics fetcher. In that case, just add the dbnomics-fetcher-toolbox package to your requirements file.

Example using pip-tools in a Python virtual environment.

# Create a Python virtual environment
python -m venv my-fetcher

# Activate the virtual environment
source my-fetcher/bin/activate

# Install dependencies management tool
pip install pip-tools

# Declare dependency
echo dbnomics-fetcher-toolbox >> requirements.in

# Freeze dependencies
pip-compile

# Synchronize the virtual environment with frozen dependencies
pip-sync

Note: this workflow is quite complex due to the Python ecosystem which does not define a standard way to manage dependencies. You can use another packaging tool like poetry.

Documentation

See https://dbnomics-fetcher-toolbox.readthedocs.io/

Contributing

Documentation

To contribute to the documentation, install:

pip install --editable .[doc]
pip install sphinx-autobuild

Then launch:

sphinx-autobuild --watch dbnomics_fetcher_toolbox doc doc/_build/html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbnomics-fetcher-toolbox-0.0.9.tar.gz (46.2 kB view hashes)

Uploaded Source

Built Distribution

dbnomics_fetcher_toolbox-0.0.9-py2.py3-none-any.whl (43.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page