| Name | caplena JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | Python Library for Caplena REST API. |
| upload_time | 2024-04-03 10:17:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
caplena
api
nlp
customer feedback
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://badge.fury.io/py/caplena)
[](https://pepy.tech/project/caplena)
# Caplena Python Library
The Caplena Python library provides convenient access to the Caplena REST API from applications written in the Python programming language.
## Documentation
To learn more about what you can use Caplena for and for how to create your own API key, please see [our main website](https://caplena.com/).
To learn more about the REST API that constitutes the basis for this project, take a look at our [REST API docs](https://caplena.com/docs/developers/).
To view the Python API docs and refernces, head over to our [SDK documentation](https://caplena.com/docs/sdk/python/).
## Installation
### Minimum Version
We recommend using the latest version of Python. Caplena supports Python 3.8 and newer.
### Dependencies
The following distributions will be installed automatically when installing Caplena.
- [Requests](https://docs.python-requests.org/en/latest/) is an elegant and simple HTTP library for Python.
- [Typing Extensions](https://github.com/python/typing/tree/master/typing_extensions) enables use of new type system features on older Python versions.
### Installing Caplena
Within your Python environment of choice, use the following command to install Caplena:
```sh
$ pip install caplena
```
Caplena is now installed.
## Development
To use `caplena-python` in a development environment, we recommend you to set up a development virtualenv. Once done, you
can run the following command to install all required dependencies:
```sh
make install
```
Run all tests:
```sh
make test
```
Run all tests in watch mode:
```sh
make test-watch
```
Run the formatter:
```sh
make fmt
```
Run the linter:
```sh
make lint
```
Build the Sphinx SDK docs:
```sh
make build-docs
```
The Sphinx generated documentation is automatically generated and uploaded to our [developer documentation portal](https://caplena.com/docs/sdk/python/), using Github Actions.
Build the Python package:
```sh
make build-sdk
```
Publish the Python package:
```sh
make publish-sdk
```
Show all supported commands:
```sh
make help
```
Raw data
{
"_id": null,
"home_page": null,
"name": "caplena",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Pascal de Buren <pascal@caplena.com>",
"keywords": "caplena, api, nlp, customer feedback",
"author": null,
"author_email": "Caplena <support@caplena.com>",
"download_url": "https://files.pythonhosted.org/packages/39/e9/440ede9c2ae6494945d980e545726d2e7179483fd4d1f28112d4873b9aff/caplena-2.0.1.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/caplena)\n[](https://pepy.tech/project/caplena)\n\n# Caplena Python Library\n\nThe Caplena Python library provides convenient access to the Caplena REST API from applications written in the Python programming language.\n\n## Documentation\n\nTo learn more about what you can use Caplena for and for how to create your own API key, please see [our main website](https://caplena.com/).\n\nTo learn more about the REST API that constitutes the basis for this project, take a look at our [REST API docs](https://caplena.com/docs/developers/).\n\nTo view the Python API docs and refernces, head over to our [SDK documentation](https://caplena.com/docs/sdk/python/).\n\n## Installation\n\n### Minimum Version\n\nWe recommend using the latest version of Python. Caplena supports Python 3.8 and newer.\n\n### Dependencies\n\nThe following distributions will be installed automatically when installing Caplena.\n\n- [Requests](https://docs.python-requests.org/en/latest/) is an elegant and simple HTTP library for Python.\n- [Typing Extensions](https://github.com/python/typing/tree/master/typing_extensions) enables use of new type system features on older Python versions.\n\n### Installing Caplena\n\nWithin your Python environment of choice, use the following command to install Caplena:\n\n```sh\n$ pip install caplena\n```\n\nCaplena is now installed.\n\n## Development\n\nTo use `caplena-python` in a development environment, we recommend you to set up a development virtualenv. Once done, you\ncan run the following command to install all required dependencies:\n\n```sh\nmake install\n```\n\nRun all tests:\n\n```sh\nmake test\n```\n\nRun all tests in watch mode:\n\n```sh\nmake test-watch\n```\n\nRun the formatter:\n\n```sh\nmake fmt\n```\n\nRun the linter:\n\n```sh\nmake lint\n```\n\nBuild the Sphinx SDK docs:\n\n```sh\nmake build-docs\n```\n\nThe Sphinx generated documentation is automatically generated and uploaded to our [developer documentation portal](https://caplena.com/docs/sdk/python/), using Github Actions.\n\nBuild the Python package:\n\n```sh\nmake build-sdk\n```\n\nPublish the Python package:\n\n```sh\nmake publish-sdk\n```\n\nShow all supported commands:\n\n```sh\nmake help\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Library for Caplena REST API.",
"version": "2.0.1",
"project_urls": {
"API Reference": "https://developers.caplena.com/sdk/python",
"Bug Tracker": "https://github.com/caplena/caplena-python/issues",
"Documentation": "https://caplena.com/docs/developers/",
"Homepage": "https://caplena.com",
"Source Code": "https://github.com/caplena/caplena-python"
},
"split_keywords": [
"caplena",
" api",
" nlp",
" customer feedback"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6b3f3f03f6dc1ffbc9f41ea549c8ee28272969f944cabb8363db50678a70fc63",
"md5": "2a6cff49f990b4c2a1d1afe2b39e5350",
"sha256": "e443083dde2de524e9d8b6746dd444f505e3d0925c744510d27cc3e3aaa5cc28"
},
"downloads": -1,
"filename": "caplena-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a6cff49f990b4c2a1d1afe2b39e5350",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32987,
"upload_time": "2024-04-03T10:17:11",
"upload_time_iso_8601": "2024-04-03T10:17:11.227767Z",
"url": "https://files.pythonhosted.org/packages/6b/3f/3f03f6dc1ffbc9f41ea549c8ee28272969f944cabb8363db50678a70fc63/caplena-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "39e9440ede9c2ae6494945d980e545726d2e7179483fd4d1f28112d4873b9aff",
"md5": "d04990a9933f64fe529d20a2a68c28a6",
"sha256": "77437563f51388cfa9556a82efa87ad3b866ca6a58a268daf2e17412ce392b87"
},
"downloads": -1,
"filename": "caplena-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d04990a9933f64fe529d20a2a68c28a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 47925,
"upload_time": "2024-04-03T10:17:25",
"upload_time_iso_8601": "2024-04-03T10:17:25.805611Z",
"url": "https://files.pythonhosted.org/packages/39/e9/440ede9c2ae6494945d980e545726d2e7179483fd4d1f28112d4873b9aff/caplena-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 10:17:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "caplena",
"github_project": "caplena-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "caplena"
}
