Skip to main content

A simple python package for creating economic models and data objects using FRED API data.

Project description

A simple python package for creating economic models and data objects using FRED API data.

This package is still in beta. Please try it out and report any comments, concerns, and issues.

https://github.com/nikhilxsunder/econo-objects/actions/workflows/main.yml/badge.svg https://img.shields.io/pypi/v/econo-objects.svg https://img.shields.io/pypi/dm/econo-objects.svg

Latest Update

  • First prerelease version published

Installation

You can install the package using pip:

pip install econo-objects

Package Usage

I recommend consulting the official Binance US API documentation at: econo-objects ReadTheDocs

Here is a simple example of how to use the package:

# Imports
from econo_objects import FredObject

# Set API Key
Keys.set_fred_api_key("your_api_key_here")

# Initialize Fred Object
fred_obj = FredObject("GDP", "2020-01-01", "2023-01-01")

# Plot GDP
plot = fred_obj.plot_df

Important Notes

  • Store your API keys and secrets in environment variables or set them directly.

  • Do not hardcode your API keys and secrets in your scripts.

Features

  • Easy plotting through predefined methods

  • Data output is already in pandas DataFrame format

Next Update

  • More calculations and models

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the 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

econo_objects-0.0.3.tar.gz (41.5 kB view details)

Uploaded Source

Built Distribution

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

econo_objects-0.0.3-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file econo_objects-0.0.3.tar.gz.

File metadata

  • Download URL: econo_objects-0.0.3.tar.gz
  • Upload date:
  • Size: 41.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for econo_objects-0.0.3.tar.gz
Algorithm Hash digest
SHA256 86ed2874a3a69a9858124059b44fd8102c6b44d13382075d253cbf41d60952d3
MD5 9300e72b9e456c1b2d1502e597aa3227
BLAKE2b-256 0160ab240b79f0d79b6ead67368d2effb51f9df74fce6e22c73c97660280167e

See more details on using hashes here.

Provenance

The following attestation bundles were made for econo_objects-0.0.3.tar.gz:

Publisher: main.yml on nikhilxsunder/econo-objects

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file econo_objects-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: econo_objects-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 29.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for econo_objects-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 303693abf0075ae4e4fa632a83daf970823a3ac8b7fb77e3e111208a721fb4a6
MD5 c36573f130c3b450d865efe980ae38d2
BLAKE2b-256 e3ed6766aac5558e446df9514ab7b26f0c8830f059a490afc7d0e8af9c0a2775

See more details on using hashes here.

Provenance

The following attestation bundles were made for econo_objects-0.0.3-py3-none-any.whl:

Publisher: main.yml on nikhilxsunder/econo-objects

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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