# Warrant Python Library
Use [Warrant](https://warrant.dev/) in Python projects.
[![PyPI](https://img.shields.io/pypi/v/warrant-python)](https://pypi.org/project/warrant-python/)
[![Slack](https://img.shields.io/badge/slack-join-brightgreen)](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w)
## Installation
```python
pip install warrant-python
```
## Usage
```python
import warrant
warrant.api_key = "api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E="
warrant.User.create()
warrant.Tenant.create(id="dunder_mifflin")
```
## Configuring the API Endpoint
---
The API endpoint the SDK makes requests to is configurable via the `warrant.api_endpoint` attribute:
```python
import warrant
# Set api endpoint to http://localhost:8000
warrant.api_endpoint = 'http://localhost:8000'
```
We’ve used a random API key in these code examples. Replace it with your
[actual publishable API keys](https://app.warrant.dev) to
test this code through your own Warrant account.
For more information on how to use the Warrant API, please refer to the
[Warrant API reference](https://docs.warrant.dev).
Note that we may release new [minor and patch](https://semver.org/) versions of this library with small but backwards-incompatible fixes to the type declarations. These changes will not affect Warrant itself.
## Warrant Documentation
- [Warrant Docs](https://docs.warrant.dev/)
Raw data
{
"_id": null,
"home_page": "https://github.com/warrant-dev/warrant-python",
"name": "warrant-python",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "warrant api authorization access control",
"author": "Warrant",
"author_email": "hello@warrant.dev",
"download_url": "https://files.pythonhosted.org/packages/d4/d9/7a269fc06a07e64d23f7823b58e7e8fcf5e3bd3b9e7c954689b75c96787a/warrant-python-3.1.0.tar.gz",
"platform": null,
"description": "# Warrant Python Library\n\nUse [Warrant](https://warrant.dev/) in Python projects.\n\n[![PyPI](https://img.shields.io/pypi/v/warrant-python)](https://pypi.org/project/warrant-python/)\n[![Slack](https://img.shields.io/badge/slack-join-brightgreen)](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w)\n\n## Installation\n\n```python\npip install warrant-python\n```\n\n## Usage\n\n```python\nimport warrant\n\nwarrant.api_key = \"api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E=\"\n\nwarrant.User.create()\nwarrant.Tenant.create(id=\"dunder_mifflin\")\n```\n\n## Configuring the API Endpoint\n---\nThe API endpoint the SDK makes requests to is configurable via the `warrant.api_endpoint` attribute:\n\n```python\nimport warrant\n\n# Set api endpoint to http://localhost:8000\nwarrant.api_endpoint = 'http://localhost:8000'\n```\n\nWe\u2019ve used a random API key in these code examples. Replace it with your\n[actual publishable API keys](https://app.warrant.dev) to\ntest this code through your own Warrant account.\n\nFor more information on how to use the Warrant API, please refer to the\n[Warrant API reference](https://docs.warrant.dev).\n\nNote that we may release new [minor and patch](https://semver.org/) versions of this library with small but backwards-incompatible fixes to the type declarations. These changes will not affect Warrant itself.\n\n## Warrant Documentation\n\n- [Warrant Docs](https://docs.warrant.dev/)\n",
"bugtrack_url": null,
"license": "Apache Software License (http://www.apache.org/licenses/LICENSE-2.0.txt)",
"summary": "Python SDK for Warrant",
"version": "3.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/warrant-dev/warrant-python/issues",
"Documentation": "https://docs.warrant.dev",
"Homepage": "https://github.com/warrant-dev/warrant-python",
"Source Code": "https://github.com/warrant-dev/warrant-python"
},
"split_keywords": [
"warrant",
"api",
"authorization",
"access",
"control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "51a623a1c2f0948e50d9228ff8704e4e6878d2c20c5677ede5f75a3caf72799f",
"md5": "3877c26a870099f6bcfbfe2576806812",
"sha256": "d7e437aa9bc789faafee899a1999cd8e5e04c842a381238346f9f7dfb2292722"
},
"downloads": -1,
"filename": "warrant_python-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3877c26a870099f6bcfbfe2576806812",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15023,
"upload_time": "2023-11-16T19:12:35",
"upload_time_iso_8601": "2023-11-16T19:12:35.724429Z",
"url": "https://files.pythonhosted.org/packages/51/a6/23a1c2f0948e50d9228ff8704e4e6878d2c20c5677ede5f75a3caf72799f/warrant_python-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d4d97a269fc06a07e64d23f7823b58e7e8fcf5e3bd3b9e7c954689b75c96787a",
"md5": "538abf4faa4e3cb7ad6a7ccf87fce7cc",
"sha256": "8caae1c5812949669961acda91502e0180259b802492602efdddfb0dc4f392cc"
},
"downloads": -1,
"filename": "warrant-python-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "538abf4faa4e3cb7ad6a7ccf87fce7cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13868,
"upload_time": "2023-11-16T19:12:37",
"upload_time_iso_8601": "2023-11-16T19:12:37.571678Z",
"url": "https://files.pythonhosted.org/packages/d4/d9/7a269fc06a07e64d23f7823b58e7e8fcf5e3bd3b9e7c954689b75c96787a/warrant-python-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 19:12:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "warrant-dev",
"github_project": "warrant-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "warrant-python"
}