Skip to main content

DBnomics Python client

Project description

DBnomics Python client

Download time series from DBnomics and access it as a Pandas DataFrame.

This package is compatible with Python >= 3.8. (TODO vermin)

Documentation

Quick start

Tutorial

A tutorial showing how to download series as a DataFrame and plot them is available as a notebook.

Install

pip install dbnomics

See also: https://pypi.org/project/DBnomics/

Configuration

Use with a proxy

This Python package uses requests, which is able to work with a proxy (HTTP/HTTPS, SOCKS). For more information, please check its documentation.

Customize the API base URL

If you plan to use a local Web API, running on the port 5000, you'll need to use the api_base_url parameter of the fetch_* functions, like this:

df = fetch_series(
    api_base_url='http://localhost:5000',
    provider_code='AMECO',
    dataset_code='ZUTN',
)

Or globally change the default API URL used by the dbnomics module, like this:

import dbnomics
dbnomics.default_api_base_url = "http://localhost:5000"

Development

To work on dbnomics-python-client source code:

git clone https://git.nomics.world/dbnomics/dbnomics-python-client.git
cd dbnomics-python-client
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .

Open the demo notebook

Install jupyter if not already done, in a virtualenv:

pip install jupyter
jupyter notebook index.ipynb

Tests

pip install -r requirements.txt
pip install -r requirements-test.txt
pip install -e .

pytest

# Specify an alternate API URL
API_URL=http://localhost:5000 pytest

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-1.2.7.tar.gz (10.8 MB view details)

Uploaded Source

Built Distribution

dbnomics-1.2.7-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

Details for the file dbnomics-1.2.7.tar.gz.

File metadata

  • Download URL: dbnomics-1.2.7.tar.gz
  • Upload date:
  • Size: 10.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for dbnomics-1.2.7.tar.gz
Algorithm Hash digest
SHA256 d5b754e53df16a11b286a8cdbacc1b4cf6d3461a664c0485e7ff7862d663e59a
MD5 4b7f96e281222a7b2c8c2c6fa92eba86
BLAKE2b-256 5928921d4e8c8c5d191111d9f952f1124ad7bc700b7b2c085fdbd79deac5c0d0

See more details on using hashes here.

File details

Details for the file dbnomics-1.2.7-py3-none-any.whl.

File metadata

  • Download URL: dbnomics-1.2.7-py3-none-any.whl
  • Upload date:
  • Size: 32.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for dbnomics-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7fda5b25bd0c5a7567a4a02a1bd3b1643173e21b8d433640e7179822f380b3d1
MD5 e4b6d636014e883d4c9467d00ad1c4e3
BLAKE2b-256 4a5f7adedbcafe6951ac4d1e96ed638f323a189e3ed94b41ce26f2c602d98171

See more details on using hashes here.

Supported by

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