Metadata-Version: 2.2
Name: circleci-api-python
Version: 0.0.1
Summary: Python API for CircleCI
Home-page: https://github.com/rkitsylinskyy/circleci-api-python
Author: Rostyslav Kitsylinskyy
Author-email: Rostyslav Kitsylinskyy <rostyslav.kitsylinskyy@gmail.com>
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.
        
Project-URL: author-homepage, https://www.linkedin.com/in/rostyslav-kitsylinskyy-587108118/
Project-URL: repository, https://github.com/rkitsylinskyy/circleci-api-python
Keywords: circleci,api,python
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: setuptools
Provides-Extra: dev
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

# 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.
