Metadata-Version: 2.1
Name: companycam-unofficial
Version: 0.1.0
Summary: Python bindings for CompanyCam API.
Home-page: https://github.com/ely-as/python-companycam
Author: Elyas Khan
Author-email: mail@ely.as
License: MIT
Project-URL: Source, https://github.com/ely-as/python-companycam
Project-URL: Tracker, https://github.com/ely-as/python-companycam/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Typing :: Typed
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx
Requires-Dist: pydantic

# python-companycam

![Test](https://github.com/ely-as/python-companycam/workflows/Test/badge.svg)
![Python](https://img.shields.io/pypi/pyversions/companycam-unofficial)
![License](https://img.shields.io/pypi/l/companycam-unofficial)

## Installation

```sh
python -m pip install git+https://github.com/ely-as/python-companycam
```

## Usage

```py
>>> import companycam
>>> from companycam.v2 import models

>>> api = companycam.API(token="YOUR_TOKEN_HERE")
>>> api.projects.list()
[Project(id='12345678', ...)]

>>> project = models.Project(name="My new project")
>>> api.projects.create(project)
Project(id='23456789', name='My new project', ...)
```

## Development

### Installation

```sh
git clone --recurse-submodules git+https://github.com/ely-as/python-companycam
cd python-companycam
python -m pip install -e .
```

### Run tests

Install [tox](https://tox.wiki/en/latest/):
```sh
python -m pip install tox
```

Run tox:
```sh
tox
```

Run a specific tox environment:
```sh
tox -e flake8
```

### Update Git submodules

```sh
git submodule foreach git pull
```

## Resources

- [CompanyCam Docs](https://docs.companycam.com/docs)

## Dependencies

- [HTTPX](https://www.python-httpx.org/) (BSD 3-clause license)
- [pydantic](https://pydantic-docs.helpmanual.io/) (MIT license)

## License

[MIT](LICENSE).
