Skip to main content

A Python SDK for the ARDECO Database API.

Project description

Ardeco Py Package

Ardeco Py Package is a lightweight Python client for the ARDECO API (Annual Regional Database of the European Commission).

It allows easy access to regional socio-economic datasets through both GraphQL and REST endpoints, returning clean and ready-to-use pandas DataFrames.


Installation

pip install ardeco-py-package

Or, to test the package before release:

pip install -i https://test.pypi.org/simple/ ardeco-py-package --extra-index-url https://pypi.org/simple

Quick Example

from ardeco_py_package import Ardeco

# Initialize the ARDECO client
ardeco = Ardeco()

# Get available variables
variables = ardeco.get_variable_list()
print(variables.head())

# Access variable dimensions (auto-formatted)
variable = ardeco.get_variable("SNPTN")
print(variable.dimensions)
# {'age': ['TOTAL', 'Y_LT15', 'Y_GE65'], 'sex': ['F', 'M'], 'unit': ['NR']}

# Fetch data for a specific variable
data = ardeco.get_data(
    "SNPTN",
    unit="NR",
    age="TOTAL",
    nuts_versions=2024,
    date=2021
)
print(data.head())

Main Features

  • Retrieve variable and dataset lists from the ARDECO API
  • Filter datasets by multiple dimensions (unit, sex, age, etc.) and columns (territory_id, date, and level_id)
  • Download structured CSV data as pandas.DataFrame
  • Query TERCET classifications for territorial analysis

Methods Overview

Method Description
get_variable_list() List all available variables
get_variable(var_code) Get details of a specific variable
get_dataset_list(var_code) Retrieve available datasets
get_data(var_code, **filters) Fetch filtered data as DataFrame
get_tercet_list() Retrieve TERCET territorial classifications

License

This project is licensed under the EUPL v1.2 license. See the included LICENSE file for details.

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

ardeco_py_package-1.0.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ardeco_py_package-1.0.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file ardeco_py_package-1.0.0.tar.gz.

File metadata

  • Download URL: ardeco_py_package-1.0.0.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for ardeco_py_package-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a4a99afc655a055e5681faeb1a32c509268be9e47ba54c25a079225b93df50b8
MD5 8005b536f96e29adf8e485c0ede29257
BLAKE2b-256 86a445d849615d7ed089552c32a8405b33adc0e58ce5fb278dcfea55529ee978

See more details on using hashes here.

File details

Details for the file ardeco_py_package-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ardeco_py_package-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec6fb136ba35f73427a818dc37d701de06368c0e1c838077a851bbe3380f86ad
MD5 78040472551ee597ebef1fccb7fcdb1c
BLAKE2b-256 f1ed33905299e720107ccbeceec0846923368fa19021d38a3992e34f3240b51f

See more details on using hashes here.

Supported by

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