# imfp
[](https://github.com/chriscarrollsmith/imfp/actions/workflows/main.yml)
[](https://pypi.python.org/pypi/imfp)
[](https://github.com/psf/black)
`imfp`, by Christopher C. Smith, is a Python package for downloading data from the [International Monetary Fund's](http://data.imf.org/) RESTful JSON API.
**[📚 Full Documentation](https://promptlytechnologies.com/imfp/)**
## Installation
```bash
pip install -q --upgrade imfp
```
## Quick Start
```python
import imfp
# Get list of available databases
databases = imfp.imf_databases()
# Get parameters for a specific database (e.g., PCPS - Primary Commodity Price System)
params = imfp.imf_parameters("PCPS")
# Fetch data with specific parameters
df = imfp.imf_dataset(
database_id="PCPS",
freq=["A"],
start_year=2000,
end_year=2015
)
```
## Key Features
- Comprehensive access to IMF's extensive economic databases
- Parameter discovery
- Rate limit and bandwidth management
- Returns data in pandas DataFrames
## Contributing
We welcome contributions to improve `imfp`! Here's how you can help:
1. If you find a bug, please open an issue
2. To fix a bug:
- Fork the repository
- Create a fix
- Open a pull request to the `dev` branch
For maintainers: To deploy a new version:
1. Increment version with `poetry version patch/minor/major`
2. Update dependencies with `poetry update`
3. Run tests with `pytest tests`
4. Update documentation if needed
5. Push to dev
6. Open PR to main
The GitHub Actions workflow will handle code formatting, testing, and deployment to PyPI after merge.
Raw data
{
"_id": null,
"home_page": "https://promptlytechnologies.com/imfp",
"name": "imfp",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "economics, finance, IMF, API",
"author": "Christopher C. Smith",
"author_email": "christopher.smith@promptlytechnologies.com",
"download_url": "https://files.pythonhosted.org/packages/2c/32/5a195f6dd62c97637273257a44e8393eb77b3a0e41942bf1e52121aea769/imfp-1.1.3.tar.gz",
"platform": null,
"description": "# imfp\n\n[](https://github.com/chriscarrollsmith/imfp/actions/workflows/main.yml)\n[](https://pypi.python.org/pypi/imfp)\n[](https://github.com/psf/black)\n\n`imfp`, by Christopher C. Smith, is a Python package for downloading data from the [International Monetary Fund's](http://data.imf.org/) RESTful JSON API.\n\n**[\ud83d\udcda Full Documentation](https://promptlytechnologies.com/imfp/)**\n\n## Installation\n\n```bash\npip install -q --upgrade imfp\n```\n\n## Quick Start\n\n```python\nimport imfp\n\n# Get list of available databases\ndatabases = imfp.imf_databases()\n\n# Get parameters for a specific database (e.g., PCPS - Primary Commodity Price System)\nparams = imfp.imf_parameters(\"PCPS\")\n\n# Fetch data with specific parameters\ndf = imfp.imf_dataset(\n database_id=\"PCPS\",\n freq=[\"A\"],\n start_year=2000,\n end_year=2015\n)\n```\n\n## Key Features\n\n- Comprehensive access to IMF's extensive economic databases\n- Parameter discovery\n- Rate limit and bandwidth management\n- Returns data in pandas DataFrames\n\n## Contributing\n\nWe welcome contributions to improve `imfp`! Here's how you can help:\n\n1. If you find a bug, please open an issue\n2. To fix a bug:\n - Fork the repository\n - Create a fix\n - Open a pull request to the `dev` branch\n\nFor maintainers: To deploy a new version:\n1. Increment version with `poetry version patch/minor/major`\n2. Update dependencies with `poetry update`\n3. Run tests with `pytest tests`\n4. Update documentation if needed\n5. Push to dev\n6. Open PR to main\n\nThe GitHub Actions workflow will handle code formatting, testing, and deployment to PyPI after merge.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package for downloading economic data from the International Monetary Fund JSON RESTful API endpoint.",
"version": "1.1.3",
"project_urls": {
"Homepage": "https://promptlytechnologies.com/imfp",
"Repository": "https://github.com/Promptly-Technologies-LLC/imfp"
},
"split_keywords": [
"economics",
" finance",
" imf",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ebd91c679526a235f08bf81bb21d9d894105d2385d144fdf8eeb9b850fcd5e8f",
"md5": "866db444496bea3594a63038662dc0cd",
"sha256": "4730601bb47805615cfeba12c09f5174343a6fc6026e632603c62a448821f0da"
},
"downloads": -1,
"filename": "imfp-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "866db444496bea3594a63038662dc0cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 14245,
"upload_time": "2024-11-06T22:46:23",
"upload_time_iso_8601": "2024-11-06T22:46:23.077606Z",
"url": "https://files.pythonhosted.org/packages/eb/d9/1c679526a235f08bf81bb21d9d894105d2385d144fdf8eeb9b850fcd5e8f/imfp-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c325a195f6dd62c97637273257a44e8393eb77b3a0e41942bf1e52121aea769",
"md5": "5dd1e555fc4e59409ab1dfc7e28240bd",
"sha256": "6564e4d37b9eb261cd5da6c848ea57acf0fe7e06d1f1d57edd99948ef223652e"
},
"downloads": -1,
"filename": "imfp-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "5dd1e555fc4e59409ab1dfc7e28240bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 12882,
"upload_time": "2024-11-06T22:46:24",
"upload_time_iso_8601": "2024-11-06T22:46:24.951397Z",
"url": "https://files.pythonhosted.org/packages/2c/32/5a195f6dd62c97637273257a44e8393eb77b3a0e41942bf1e52121aea769/imfp-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 22:46:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Promptly-Technologies-LLC",
"github_project": "imfp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "imfp"
}
JSON
