| Name | curatedapi-wm JSON |
| Version |
0.9.2
JSON |
| download |
| home_page | |
| Summary | This package provides a Python interface for the Curated API. With it, you can easily manage issues, links, and subscribers within publications. |
| upload_time | 2023-10-16 00:56:32 |
| maintainer | |
| docs_url | None |
| author | William Mincy |
| requires_python | >=3.7 |
| license | |
| keywords |
python
newsletter
curated
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Example Package: Curated API
This package provides a Python interface for the Curated API. With it, you can easily manage issues, links, and subscribers within publications using the `CuratedApi` class.
## Installation
To install the package, you can use pip:
```
pip install curatedapi_wm
```
## Usage
To use the `CuratedApi` class within your Python project:
```python
from curatedapi import CuratedApi
api_key = "YOUR_API_KEY"
curated_api = CuratedApi(api_key)
```
Make sure to replace `"YOUR_API_KEY"` with your actual Curated API key in order to gain access to your account via the API. Please see the documentation provided by Curated for [getting started with the Curated API](https://support.curated.co/help/getting-started-with-the-api)
### Setting publication id
_You must perform this step or you cannot communicate with the Curated API_
To target any individual publication within the API you'll need to get its id from within Curated. You can also achieve this by reviewing the results from the following API call:
```python
print(curated_api.request_all_publications())
```
This will return a JSON response containing all publications within your account. Choose the ID from the one you want to target and assign that to the `curated_api` instance you have created.
```python
publication_id = "YOUR_PUBLICATION_ID"
curated_api.set_publication_id(publication_id)
```
###
## Tests
The package comes with a set of tests. To run the tests:
1. Navigate to the package directory.
2. Run the test files using Python:
```
python -m unittest tests/test_curated_api.py
python -m unittest tests/test_curated_category.py
python -m unittest tests/test_curated_link.py
```
## License
This package is licensed under the MIT license. See the LICENSE file for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "curatedapi-wm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,newsletter,curated,api",
"author": "William Mincy",
"author_email": "William Mincy <me@williammincy.com>",
"download_url": "https://files.pythonhosted.org/packages/7d/d4/ff853d42a57c255d2407040a17523279b58107700436472716b1f62b63f7/curatedapi_wm-0.9.2.tar.gz",
"platform": null,
"description": "# Example Package: Curated API\r\n\r\nThis package provides a Python interface for the Curated API. With it, you can easily manage issues, links, and subscribers within publications using the `CuratedApi` class.\r\n\r\n## Installation\r\n\r\nTo install the package, you can use pip:\r\n\r\n```\r\npip install curatedapi_wm\r\n```\r\n\r\n## Usage\r\n\r\nTo use the `CuratedApi` class within your Python project:\r\n\r\n```python\r\nfrom curatedapi import CuratedApi\r\n\r\napi_key = \"YOUR_API_KEY\"\r\ncurated_api = CuratedApi(api_key)\r\n```\r\n\r\nMake sure to replace `\"YOUR_API_KEY\"` with your actual Curated API key in order to gain access to your account via the API. Please see the documentation provided by Curated for [getting started with the Curated API](https://support.curated.co/help/getting-started-with-the-api)\r\n\r\n### Setting publication id\r\n\r\n_You must perform this step or you cannot communicate with the Curated API_\r\n\r\nTo target any individual publication within the API you'll need to get its id from within Curated. You can also achieve this by reviewing the results from the following API call:\r\n\r\n```python\r\nprint(curated_api.request_all_publications())\r\n```\r\n\r\nThis will return a JSON response containing all publications within your account. Choose the ID from the one you want to target and assign that to the `curated_api` instance you have created.\r\n\r\n```python\r\npublication_id = \"YOUR_PUBLICATION_ID\"\r\ncurated_api.set_publication_id(publication_id)\r\n```\r\n\r\n###\r\n\r\n## Tests\r\n\r\nThe package comes with a set of tests. To run the tests:\r\n\r\n1. Navigate to the package directory.\r\n2. Run the test files using Python:\r\n\r\n```\r\npython -m unittest tests/test_curated_api.py\r\npython -m unittest tests/test_curated_category.py\r\npython -m unittest tests/test_curated_link.py\r\n```\r\n\r\n## License\r\n\r\nThis package is licensed under the MIT license. See the LICENSE file for more details.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "This package provides a Python interface for the Curated API. With it, you can easily manage issues, links, and subscribers within publications.",
"version": "0.9.2",
"project_urls": {
"Bug Tracker": "https://github.com/williammincy/CuratedAPI/issues",
"Homepage": "https://github.com/williammincy/CuratedAPI"
},
"split_keywords": [
"python",
"newsletter",
"curated",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "898f9ccbb3be8cd0db42f5c8ac6765034d797072b8b5365381d88c4271a2b153",
"md5": "1c409fa1a52f0f7d6156149dbd96d144",
"sha256": "f10615685c533672220238f4645442d74089802b5f1f258e099a58974645418e"
},
"downloads": -1,
"filename": "curatedapi_wm-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c409fa1a52f0f7d6156149dbd96d144",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2930,
"upload_time": "2023-10-16T00:56:30",
"upload_time_iso_8601": "2023-10-16T00:56:30.851555Z",
"url": "https://files.pythonhosted.org/packages/89/8f/9ccbb3be8cd0db42f5c8ac6765034d797072b8b5365381d88c4271a2b153/curatedapi_wm-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7dd4ff853d42a57c255d2407040a17523279b58107700436472716b1f62b63f7",
"md5": "2581b66f988b4e58c7569a5a86581261",
"sha256": "4a151999455f49ebf12c92a49d6df25e76f149e908bfde179c1e299126223f54"
},
"downloads": -1,
"filename": "curatedapi_wm-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "2581b66f988b4e58c7569a5a86581261",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4060,
"upload_time": "2023-10-16T00:56:32",
"upload_time_iso_8601": "2023-10-16T00:56:32.508231Z",
"url": "https://files.pythonhosted.org/packages/7d/d4/ff853d42a57c255d2407040a17523279b58107700436472716b1f62b63f7/curatedapi_wm-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-16 00:56:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "williammincy",
"github_project": "CuratedAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "curatedapi-wm"
}
