Skip to main content

A robust Python library to parse API JSON responses into DataFrames with date handling.

Project description

JBridgeDF

PyPI version License: MIT Tests Python

Bridge JSON APIs into clean, time-aware DataFrames.

JBridgeDF is a lightweight Python library that simplifies the process of retrieving and transforming JSON data from APIs into tidy pandas DataFrames — ready for analysis or time series modeling.

🚀 Features

  • Handles HTTP requests and error logging
  • Parses JSON responses into clean DataFrames
  • Handles different JSON answers: plain dict, list of dicts, key-word dict
  • Filters out metadata
  • Automatically removes inconsistent or empty columns
  • Converts timestamps and standardizes time frequency (daily, monthly, quarterly)
  • Designed for public data APIs (like Central Bank, IBGE, FRED, etc.)

📦 Installation

You can install JBridgeDF directly from PyPI:

pip install jbridgedf

```bash
pip install -e .

🧪 Example Usage

from jbridgedf.parser import APIDataParser

parser = APIDataParser()
df = parser.get_from_api(
    url="https://api.bcb.gov.br/dados/serie/bcdata.sgs.11/dados?formato=json",
    variable_list=["data", "valor"],
    is_list=True,
    frequency="monthly",
    date_as_index=True
)
print(df.head())

📁 Project Structure

  • jbridgedf/: core library code
  • tests/: unit tests (pytest recommended)
  • examples/: real-world examples and demos

📬 Contact

For questions, suggestions, or contributions, open an issue on GitHub or email at luismoraes.datascience@gmail.com.

🤝 Ethical Use

This library was developed with the intention of supporting researchers, analysts, and developers working with open or public data APIs.

If you plan to use JBridgeDF in commercial applications, redistributed packages, or mission-critical systems, you are kindly encouraged to retain the original context, acknowledge the author, and consider contributing back.

This is not a legal restriction, but a request to respect the original purpose and community spirit of the project.

📄 License

MIT

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

jbridgedf-0.1.4.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

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

jbridgedf-0.1.4-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file jbridgedf-0.1.4.tar.gz.

File metadata

  • Download URL: jbridgedf-0.1.4.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for jbridgedf-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d6badb79fb84db8bf88cbd69836e33831f9697c28067f02413097ba00a07eea1
MD5 1fd950f8259c8d0e1e1cdf88587415ed
BLAKE2b-256 50c93e40267dbce90ee74f8eab35625eae71d6637cbe8ea27e4fa9b70cc12880

See more details on using hashes here.

File details

Details for the file jbridgedf-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: jbridgedf-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for jbridgedf-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3346a44a6036d251f0cecfad578cc8ee872e428c2bdd00f60fc011a34d4cbcf9
MD5 0473bd6b2101dce1b2142fc08c9f5aa8
BLAKE2b-256 e0aba24d6fd35dde336d866f2e36e10c6b30056ffa4b8a62b31b0f1a06f28c01

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