| Name | acrclient JSON |
| Version |
0.4.6
JSON |
| download |
| home_page | None |
| Summary | API wrapper for the v2 ACRCloud API |
| upload_time | 2024-05-27 21:58:22 |
| maintainer | None |
| docs_url | None |
| author | RaBe IT-Reaktion |
| requires_python | <4.0,>=3.11 |
| license | AGPL-v3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python ACR Client module
Contains a simple client for calling the v2 endpoints of the [ACRCloud](https://www.acrcloud.com) API.
## Installation
```bash
poetry add acrclient
# or on old setup style projects
pip -m install acrclient
```
## Usage
```python
>>> from acrclient import Client
>>> client = Client(bearer_token="bearer-token")
```
## Development
```bash
# setup a dev env
python -mvenv env
. env/bin/activate
# install a modern poetry version
python -mpip install poetry>=1.2.0
# install deps and dev version
poetry install
# make changes, run tests
poetry run pytest
```
## Release Management
The CI/CD setup uses semantic commit messages following the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/).
There is a GitHub Action in [.github/workflows/semantic-release.yaml](./.github/workflows/semantic-release.yaml)
that uses [go-semantic-commit](https://go-semantic-release.xyz/) to create new
releases.
The commit message should be structured as follows:
```
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
```
The commit contains the following structural elements, to communicate intent to the consumers of your library:
1. **fix:** a commit of the type `fix` patches gets released with a PATCH version bump
1. **feat:** a commit of the type `feat` gets released as a MINOR version bump
1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:` gets released as a MAJOR version bump
1. types other than `fix:` and `feat:` are allowed and don't trigger a release
If a commit does not contain a conventional commit style message you can fix
it during the squash and merge operation on the PR.
Once a commit has landed on the `main` branch a release will be created and automatically published to [pypi](https://pypi.org/)
using the GitHub Action in [.github/workflows/release.yaml](./.github/workflows/release.yaml) which uses [poetry](https://python-poetry.org/)
to publish the package to pypi.
## License
This package is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
## Copyright
Copyright (c) 2023 [Radio Bern RaBe](http://www.rabe.ch)
Raw data
{
"_id": null,
"home_page": null,
"name": "acrclient",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "RaBe IT-Reaktion",
"author_email": "it@rabe.ch",
"download_url": "https://files.pythonhosted.org/packages/46/86/4d56b27be7381eeea7e49c389fc334a4eb5db012eb92c571ff17b0b155c4/acrclient-0.4.6.tar.gz",
"platform": null,
"description": "# Python ACR Client module\n\nContains a simple client for calling the v2 endpoints of the [ACRCloud](https://www.acrcloud.com) API.\n\n## Installation\n\n```bash\npoetry add acrclient\n\n# or on old setup style projects\npip -m install acrclient\n```\n\n## Usage\n\n```python\n>>> from acrclient import Client\n>>> client = Client(bearer_token=\"bearer-token\")\n\n```\n\n## Development\n\n```bash\n# setup a dev env\npython -mvenv env\n. env/bin/activate\n\n# install a modern poetry version\npython -mpip install poetry>=1.2.0\n\n# install deps and dev version\npoetry install\n\n# make changes, run tests\npoetry run pytest\n```\n\n## Release Management\n\nThe CI/CD setup uses semantic commit messages following the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/).\nThere is a GitHub Action in [.github/workflows/semantic-release.yaml](./.github/workflows/semantic-release.yaml)\nthat uses [go-semantic-commit](https://go-semantic-release.xyz/) to create new\nreleases.\n\nThe commit message should be structured as follows:\n\n```\n<type>[optional scope]: <description>\n\n[optional body]\n\n[optional footer(s)]\n```\n\nThe commit contains the following structural elements, to communicate intent to the consumers of your library:\n\n1. **fix:** a commit of the type `fix` patches gets released with a PATCH version bump\n1. **feat:** a commit of the type `feat` gets released as a MINOR version bump\n1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:` gets released as a MAJOR version bump\n1. types other than `fix:` and `feat:` are allowed and don't trigger a release\n\nIf a commit does not contain a conventional commit style message you can fix\nit during the squash and merge operation on the PR.\n\nOnce a commit has landed on the `main` branch a release will be created and automatically published to [pypi](https://pypi.org/)\nusing the GitHub Action in [.github/workflows/release.yaml](./.github/workflows/release.yaml) which uses [poetry](https://python-poetry.org/)\nto publish the package to pypi.\n\n## License\n\nThis package is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.\n\n## Copyright\n\nCopyright (c) 2023 [Radio Bern RaBe](http://www.rabe.ch)\n",
"bugtrack_url": null,
"license": "AGPL-v3",
"summary": "API wrapper for the v2 ACRCloud API",
"version": "0.4.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd91db6b5debb33cd5166484e79a86319fc80970ffd94e87791cae9c8c3a03f9",
"md5": "f616c672e377013196fe945869d92748",
"sha256": "c495c37b8d76bc826aab59bfa1dfa2f6927fe4e3944b733e913a47d816eff524"
},
"downloads": -1,
"filename": "acrclient-0.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f616c672e377013196fe945869d92748",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 4947,
"upload_time": "2024-05-27T21:58:21",
"upload_time_iso_8601": "2024-05-27T21:58:21.172027Z",
"url": "https://files.pythonhosted.org/packages/dd/91/db6b5debb33cd5166484e79a86319fc80970ffd94e87791cae9c8c3a03f9/acrclient-0.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46864d56b27be7381eeea7e49c389fc334a4eb5db012eb92c571ff17b0b155c4",
"md5": "92a8f4302f0891befb5bd2bf24fe9435",
"sha256": "83dbdf0fa5d5048055c277cd1e926194fac054cad91d70b4272843f14242536f"
},
"downloads": -1,
"filename": "acrclient-0.4.6.tar.gz",
"has_sig": false,
"md5_digest": "92a8f4302f0891befb5bd2bf24fe9435",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 4321,
"upload_time": "2024-05-27T21:58:22",
"upload_time_iso_8601": "2024-05-27T21:58:22.581475Z",
"url": "https://files.pythonhosted.org/packages/46/86/4d56b27be7381eeea7e49c389fc334a4eb5db012eb92c571ff17b0b155c4/acrclient-0.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-27 21:58:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "acrclient"
}
