Name | sift-stack-py JSON |
Version |
0.8.1
JSON |
| download |
home_page | None |
Summary | Python client library for the Sift API |
upload_time | 2025-07-31 18:37:54 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.8 |
license | Copyright (c) 2024 Azimuth Industries Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
keywords |
sift
sift-stack
siftstack
sift_py
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Sift Python
[](https://pypi.org/project/sift-stack-py/)
[](https://pypi.org/project/sift-stack-py/)
[](https://docs.siftstack.com/sift_py/sift_py.html)
This library offers a Python API on top of Sift's protocol buffers to ergonomically interface with the Sift gRPC API.
## Installation
To install the Sift Python library:
```
$ pip install sift-stack-py
```
## Documentation
Documentation can be found at [this link](https://docs.siftstack.com/sift_py/sift_py.html), however, if you need
to build the documentation for offline use, read on.
### Offline documentation
To build the documentation locally:
Clone the main `sift` repository:
```
$ git clone https://github.com/sift-stack/sift.git
```
Set your working directory to this project sub-directory:
```
$ cd python
```
Install [pdoc](https://pypi.org/project/pdoc/):
```
$ pip install pdoc
```
Run `pdoc`.
```
$ pdoc lib/sift_py
```
You may optionally set the host and port used by the `pdoc` web-server using the `-p` and `-h` options.
See `pdoc --help` for more info.
Raw data
{
"_id": null,
"home_page": null,
"name": "sift-stack-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Sift Software Engineers <engineering@siftstack.com>",
"keywords": "sift, sift-stack, siftstack, sift_py",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ea/db/b0a09fc52c81241e146ca44e78e935ec637e6f35811cbc8712d4b3e7164f/sift_stack_py-0.8.1.tar.gz",
"platform": null,
"description": "# Sift Python\n[](https://pypi.org/project/sift-stack-py/)\n[](https://pypi.org/project/sift-stack-py/)\n[](https://docs.siftstack.com/sift_py/sift_py.html)\n\nThis library offers a Python API on top of Sift's protocol buffers to ergonomically interface with the Sift gRPC API.\n\n## Installation\n\nTo install the Sift Python library:\n\n```\n$ pip install sift-stack-py\n```\n\n## Documentation\n\nDocumentation can be found at [this link](https://docs.siftstack.com/sift_py/sift_py.html), however, if you need\nto build the documentation for offline use, read on.\n\n### Offline documentation\n\nTo build the documentation locally:\n\nClone the main `sift` repository:\n\n```\n$ git clone https://github.com/sift-stack/sift.git\n```\n\nSet your working directory to this project sub-directory:\n\n```\n$ cd python\n```\n\nInstall [pdoc](https://pypi.org/project/pdoc/):\n\n```\n$ pip install pdoc\n```\n\nRun `pdoc`.\n\n```\n$ pdoc lib/sift_py\n```\n\nYou may optionally set the host and port used by the `pdoc` web-server using the `-p` and `-h` options.\nSee `pdoc --help` for more info.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 Azimuth Industries Inc.\n \n Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n ",
"summary": "Python client library for the Sift API",
"version": "0.8.1",
"project_urls": {
"Changelog": "https://github.com/sift-stack/sift/tree/main/python/CHANGELOG.md",
"Documentation": "https://docs.siftstack.com/sift_py/sift_py.html",
"Homepage": "https://github.com/sift-stack/sift/tree/main/python",
"Repository": "https://github.com/sift-stack/sift/tree/main/python"
},
"split_keywords": [
"sift",
" sift-stack",
" siftstack",
" sift_py"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "99aa64d030cc3e4c1c888cfcb9522fe4db8e3156cbf5fcbdba5b75ceac9868a9",
"md5": "067909b48a59f2a9bf9cd5862dfb7e8b",
"sha256": "130a1a57ed9f5699279bee9496086dd9944f5147b8a0f7cd7558c3bd0ec60d12"
},
"downloads": -1,
"filename": "sift_stack_py-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "067909b48a59f2a9bf9cd5862dfb7e8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 617416,
"upload_time": "2025-07-31T18:37:52",
"upload_time_iso_8601": "2025-07-31T18:37:52.994028Z",
"url": "https://files.pythonhosted.org/packages/99/aa/64d030cc3e4c1c888cfcb9522fe4db8e3156cbf5fcbdba5b75ceac9868a9/sift_stack_py-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "eadbb0a09fc52c81241e146ca44e78e935ec637e6f35811cbc8712d4b3e7164f",
"md5": "7bd51f759006a843793466f2533480c7",
"sha256": "b124f1fbd04a6912a226273d4c3cdbacfca429cc3569cf861d2e9cf330a926ee"
},
"downloads": -1,
"filename": "sift_stack_py-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "7bd51f759006a843793466f2533480c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 453709,
"upload_time": "2025-07-31T18:37:54",
"upload_time_iso_8601": "2025-07-31T18:37:54.718823Z",
"url": "https://files.pythonhosted.org/packages/ea/db/b0a09fc52c81241e146ca44e78e935ec637e6f35811cbc8712d4b3e7164f/sift_stack_py-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 18:37:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sift-stack",
"github_project": "sift",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sift-stack-py"
}