fredx

Name	fredx JSON
Version	0.0.5 JSON
	download
home_page	https://github.com/AhmedThahir/fredx
Summary	St. Louis Federal Reserve FRED API
upload_time	2024-03-24 08:59:57
maintainer	None
docs_url	None
author	Ahmed Thahir
requires_python	None
license	MIT
keywords	fred api federal reserve st. louis fed async
VCS
bugtrack_url
requirements	aiolimiter httpx numpy pandas
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            
# Fred eXtreme

- Request multiple series with a single line
- Fast
- Async
- All operations using a single http client

## Installation

```bash
pip install fredx
# or
pip install "git+https://github.com/AhmedThahir/fredx"
```

## Import

```python
from fred import Fred
```

## Create Object

```python
API_KEY = ""
fred = Fred(API_KEY)
```

## Get list of series

```python
series_list_df = await (
    fred
    .get_series_list(
      tags = ["india", "monthly"],
      limit = 2
    )
)
```

## Get series data

```python
series_list = list(series_list_df["id"])
series_data = await fred.get_series(
    series_id_list = series_list,
    limit = 1
)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AhmedThahir/fredx",
    "name": "fredx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "fred, api, federal reserve, st. louis fed, async",
    "author": "Ahmed Thahir",
    "author_email": "ahmedthahir2002@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/2e/7f/f80d655271980c833efe6a7bdc9331bf0c7071e938ff6fd25cbae489e63f/fredx-0.0.5.tar.gz",
    "platform": null,
    "description": "\n# Fred eXtreme\n\n- Request multiple series with a single line\n- Fast\n- Async\n- All operations using a single http client\n\n## Installation\n\n```bash\npip install fredx\n# or\npip install \"git+https://github.com/AhmedThahir/fredx\"\n```\n\n## Import\n\n```python\nfrom fred import Fred\n```\n\n## Create Object\n\n```python\nAPI_KEY = \"\"\nfred = Fred(API_KEY)\n```\n\n## Get list of series\n\n```python\nseries_list_df = await (\n    fred\n    .get_series_list(\n      tags = [\"india\", \"monthly\"],\n      limit = 2\n    )\n)\n```\n\n## Get series data\n\n```python\nseries_list = list(series_list_df[\"id\"])\nseries_data = await fred.get_series(\n    series_id_list = series_list,\n    limit = 1\n)\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "St. Louis Federal Reserve FRED API",
    "version": "0.0.5",
    "project_urls": {
        "Homepage": "https://github.com/AhmedThahir/fredx"
    },
    "split_keywords": [
        "fred",
        " api",
        " federal reserve",
        " st. louis fed",
        " async"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f6a630d3773c9a90a86731e8f0fe14dc1a2ecc7736814e0213ce7deabe40bbb9",
                "md5": "012a4c5ddfe1a757954eeb81cf80d254",
                "sha256": "a346ab657d76bf10b358ee7f3f976c98a1e4310a5af81ef40dc342425c9c298e"
            },
            "downloads": -1,
            "filename": "fredx-0.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "012a4c5ddfe1a757954eeb81cf80d254",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3821,
            "upload_time": "2024-03-24T08:59:56",
            "upload_time_iso_8601": "2024-03-24T08:59:56.313431Z",
            "url": "https://files.pythonhosted.org/packages/f6/a6/30d3773c9a90a86731e8f0fe14dc1a2ecc7736814e0213ce7deabe40bbb9/fredx-0.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2e7ff80d655271980c833efe6a7bdc9331bf0c7071e938ff6fd25cbae489e63f",
                "md5": "b044f45d6772174e2e51c4bcdcf48811",
                "sha256": "8f952ec5e1541585698fbcf5d7623c20d886850273a74bba9f17dbb5a7400fb3"
            },
            "downloads": -1,
            "filename": "fredx-0.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "b044f45d6772174e2e51c4bcdcf48811",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3709,
            "upload_time": "2024-03-24T08:59:57",
            "upload_time_iso_8601": "2024-03-24T08:59:57.984404Z",
            "url": "https://files.pythonhosted.org/packages/2e/7f/f80d655271980c833efe6a7bdc9331bf0c7071e938ff6fd25cbae489e63f/fredx-0.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-24 08:59:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AhmedThahir",
    "github_project": "fredx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "aiolimiter",
            "specs": []
        },
        {
            "name": "httpx",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": []
        }
    ],
    "lcname": "fredx"
}