| Name | circleci-api-python JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | https://github.com/rkitsylinskyy/circleci-api-python |
| Summary | Python API for CircleCI |
| upload_time | 2025-01-17 23:10:43 |
| maintainer | None |
| docs_url | None |
| author | Rostyslav Kitsylinskyy |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 rkitsylinskyy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
circleci
api
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CircleCI API Python Client
A simple Python client for interacting with the CircleCI API.
## Installation
You can install the package using `pip`:
```bash
pip install circleci-api-python
```
## Requirements
This package requires Python 3.8 or higher.
All the dependencies are listed in the `requirements.txt` file are installed automatically when you install the package.
## Usage
### Initialization
To use the CircleCI API Python client, you need to initialize it with your CircleCI token:
```python
from circleci_api_python.client import CircleCI
client = CircleCI(token="your_circleci_token")
```
## Development
### Running Unit Tests
To run the unit tests, you can use the provided shell script:
```bash
./run_unit_tests.sh
```
Alternatively, you can run the tests using `unittest` directly:
```bash
python -m unittest discover -s tests
```
### Running Linting Checks
To run the linting checks, you can use the provided shell script:
```bash
./run_linting_checks.sh
```
## License
This project is licensed under the MIT License. See the `LICENSE` file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/rkitsylinskyy/circleci-api-python",
"name": "circleci-api-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "circleci, api, python",
"author": "Rostyslav Kitsylinskyy",
"author_email": "Rostyslav Kitsylinskyy <rostyslav.kitsylinskyy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a3/54/e87fcfd7ad57e1638179611adf783fef22ce91dfe72c4cce001aaa3430f5/circleci_api_python-0.0.2.tar.gz",
"platform": null,
"description": "# CircleCI API Python Client\n\nA simple Python client for interacting with the CircleCI API.\n\n## Installation\n\nYou can install the package using `pip`:\n\n```bash\npip install circleci-api-python\n```\n\n## Requirements\n\nThis package requires Python 3.8 or higher.\n\nAll the dependencies are listed in the `requirements.txt` file are installed automatically when you install the package.\n\n\n## Usage\n\n### Initialization\n\nTo use the CircleCI API Python client, you need to initialize it with your CircleCI token:\n\n```python\nfrom circleci_api_python.client import CircleCI\n\nclient = CircleCI(token=\"your_circleci_token\")\n```\n\n## Development\n\n### Running Unit Tests\n\nTo run the unit tests, you can use the provided shell script:\n\n```bash\n./run_unit_tests.sh\n```\n\nAlternatively, you can run the tests using `unittest` directly:\n\n```bash\npython -m unittest discover -s tests\n```\n\n### Running Linting Checks\n\nTo run the linting checks, you can use the provided shell script:\n\n```bash\n./run_linting_checks.sh\n```\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for more details.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 rkitsylinskyy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python API for CircleCI",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/rkitsylinskyy/circleci-api-python",
"author-homepage": "https://www.linkedin.com/in/rostyslav-kitsylinskyy-587108118/",
"repository": "https://github.com/rkitsylinskyy/circleci-api-python"
},
"split_keywords": [
"circleci",
" api",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e879db423d1744487a970f931847bea21d1fa04f6b7281cddf2dd76ebf254ac1",
"md5": "065074f3b7ef4a070c8edf69aff426f0",
"sha256": "af4f290255735e6fee803553ffeb50e659d4ef3944fdfb0ceec576f23aac6d47"
},
"downloads": -1,
"filename": "circleci_api_python-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "065074f3b7ef4a070c8edf69aff426f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24660,
"upload_time": "2025-01-17T23:10:41",
"upload_time_iso_8601": "2025-01-17T23:10:41.120858Z",
"url": "https://files.pythonhosted.org/packages/e8/79/db423d1744487a970f931847bea21d1fa04f6b7281cddf2dd76ebf254ac1/circleci_api_python-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a354e87fcfd7ad57e1638179611adf783fef22ce91dfe72c4cce001aaa3430f5",
"md5": "c89496cdcee56780bd8dfb6ffe59f0b6",
"sha256": "f692a70475c284a41d0b5b2fc45ac701a7032f00c0da273fd3b611a2f4415278"
},
"downloads": -1,
"filename": "circleci_api_python-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c89496cdcee56780bd8dfb6ffe59f0b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19131,
"upload_time": "2025-01-17T23:10:43",
"upload_time_iso_8601": "2025-01-17T23:10:43.417195Z",
"url": "https://files.pythonhosted.org/packages/a3/54/e87fcfd7ad57e1638179611adf783fef22ce91dfe72c4cce001aaa3430f5/circleci_api_python-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-17 23:10:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rkitsylinskyy",
"github_project": "circleci-api-python",
"github_not_found": true,
"lcname": "circleci-api-python"
}
