# Overview
This library contains useful wrappers around the Tonic Textual API
## Usage
Instantiate the API wrapper using the following code:
```
from tonic_textual.redact_api import TonicTextual
# Do not include trailing backslash in TONIC_URL
api = TonicTextual(TONIC_TEXTUAL_URL, API_KEY)
```
Once instantiated, the following endpoints are available for consumption. Note that available endpoints and response types are limited. Available fields may be severely limited compared to the current Tonic API.
## Build and package
Update the version in pyproject.toml. Ensure you are in the python_sdk/ folder in the repo root for the following instructions.
Update build and twine
```
python -m pip install --upgrade build
python -m pip install --upgrade twine
```
Clean out dist folder
```
rm dist/ -rf
```
Now build
```
python -m build
```
And ship
```
python -m twine upload .\dist\*
```
The username is __token__ and the pw is your token including the 'pypi-'
Raw data
{
"_id": null,
"home_page": "https://www.tonic.ai/",
"name": "tonic-textual",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "tonic.ai, tonic, tonic textual",
"author": "Adam Kamor",
"author_email": "adam@tonic.ai",
"download_url": "https://files.pythonhosted.org/packages/8b/40/fdc586e9d1afe383cf9183166bee3184313e0197220880a4e2254e4572b0/tonic_textual-2.0.0.tar.gz",
"platform": null,
"description": "# Overview\nThis library contains useful wrappers around the Tonic Textual API\n\n## Usage\n\nInstantiate the API wrapper using the following code:\n\n```\nfrom tonic_textual.redact_api import TonicTextual\n\n# Do not include trailing backslash in TONIC_URL\napi = TonicTextual(TONIC_TEXTUAL_URL, API_KEY)\n```\n\nOnce instantiated, the following endpoints are available for consumption. Note that available endpoints and response types are limited. Available fields may be severely limited compared to the current Tonic API.\n\n## Build and package\n\nUpdate the version in pyproject.toml. Ensure you are in the python_sdk/ folder in the repo root for the following instructions.\n\nUpdate build and twine\n\n```\npython -m pip install --upgrade build\npython -m pip install --upgrade twine\n```\n\nClean out dist folder\n\n```\nrm dist/ -rf\n```\n\nNow build\n\n```\npython -m build\n```\n\nAnd ship\n\n```\npython -m twine upload .\\dist\\*\n```\n\nThe username is __token__ and the pw is your token including the 'pypi-'\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wrappers around the Tonic Textual API",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://www.tonic.ai/"
},
"split_keywords": [
"tonic.ai",
" tonic",
" tonic textual"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "413d3be5412e9e49cb95ac98e78a7d4d71f65fae64efc59bf31da744dd56094f",
"md5": "d91490727535a70dca454f12db062ec1",
"sha256": "b9c47122e9d338995329f11bcd6bf62bb4d142d616b984d370a672a859bf5059"
},
"downloads": -1,
"filename": "tonic_textual-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d91490727535a70dca454f12db062ec1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 30801,
"upload_time": "2024-05-24T23:06:02",
"upload_time_iso_8601": "2024-05-24T23:06:02.706346Z",
"url": "https://files.pythonhosted.org/packages/41/3d/3be5412e9e49cb95ac98e78a7d4d71f65fae64efc59bf31da744dd56094f/tonic_textual-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b40fdc586e9d1afe383cf9183166bee3184313e0197220880a4e2254e4572b0",
"md5": "9dd9278a08d5c9eae920e269166cfb8e",
"sha256": "532bdee22b928d14038bf456fe673c716c7f9e7f7fc2551aabc73769efaa46c3"
},
"downloads": -1,
"filename": "tonic_textual-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9dd9278a08d5c9eae920e269166cfb8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 18890,
"upload_time": "2024-05-24T23:06:04",
"upload_time_iso_8601": "2024-05-24T23:06:04.522830Z",
"url": "https://files.pythonhosted.org/packages/8b/40/fdc586e9d1afe383cf9183166bee3184313e0197220880a4e2254e4572b0/tonic_textual-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-24 23:06:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tonic-textual"
}