| Name | aperturedb JSON |
| Version |
0.4.36
JSON |
| download |
| home_page | None |
| Summary | ApertureDB Python SDK |
| upload_time | 2024-10-29 21:40:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | The MIT License @copyright Copyright (c) 2017 Intel Corporation @copyright Copyright (c) 2024 ApertureData 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 |
aperturedb
graph
database
image
video
metadata
search
indexing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ApertureDB Client Python Module
This is the Python SDK for building applications with [ApertureDB](https://docs.aperturedata.io/Introduction/WhatIsAperture).
This comprises of utilities to get sata in and out of ApertureDB in an optimal manner.
A quick [getting started guide](https://docs.aperturedata.io/HowToGuides/start/Setup) is useful to start building with this SDK.
For more concrete examples, please refer to:
* [Simple examples and concepts](https://docs.aperturedata.io/category/simple-usage-examples)
* [Advanced usage examples](https://docs.aperturedata.io/category/advanced-usage-examples)
# Installing in a custom virtual enviroment
```bash
pip install aperturedb[complete]
```
or an installation with only the core part of the SDK
```bash
pip install aperturedb
```
A complete [reference](https://docs.aperturedata.io/category/aperturedb-python-sdk) of this SDK is available on the offical [ApertureDB Documentation](https://docs.aperturedata.io)
# Development setup
The recommended way is to clone this repo, and do an editable install as follows:
```bash
git clone https://github.com/aperture-data/aperturedb-python.git
cd aperturedb-python
pip install -e .[dev]
```
# Running tests
The tests are inside the `test` dir.
All the tests can be run with:
```bash
export GCP_SERVICE_ACCOUNT_KEY=<content of a GCP SERVICE ACCOUNT JSON file>
bash run_test.sh
```
Running specefic tests can be accomplished by invoking it with pytest as follows:
```bash
cd test && docker compose up -d && PROJECT=aperturedata KAGGLE_username=ci KAGGLE_key=dummy coverage run -m python -m pytest test_Session.py -v --log-cli-level=DEBUG
```
# Reporting bugs
Any error in the functionality / documentation / tests maybe reported by creating a
[github issue](https://github.com/aperture-data/aperturedb-python/issues).
# Development guidelines
For inclusion of any features, a PR may be created with a patch,
and a brief description of the problem and the fix.
The CI enforces a coding style guideline with autopep8 and
a script to detect trailing white spaces.
If a PR encounters failures, the log will describe the location of
the offending line with a description of the problem.
Raw data
{
"_id": null,
"home_page": null,
"name": "aperturedb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "aperturedb, graph, database, image, video, metadata, search, indexing",
"author": null,
"author_email": "ApertureData Engineering <team@aperturedata.io>",
"download_url": "https://files.pythonhosted.org/packages/51/90/b740afcb270cd24b02fd9ad411340895e4951e41aa0844c72d802905a1d2/aperturedb-0.4.36.tar.gz",
"platform": null,
"description": "# ApertureDB Client Python Module\n\nThis is the Python SDK for building applications with [ApertureDB](https://docs.aperturedata.io/Introduction/WhatIsAperture).\n\nThis comprises of utilities to get sata in and out of ApertureDB in an optimal manner.\nA quick [getting started guide](https://docs.aperturedata.io/HowToGuides/start/Setup) is useful to start building with this SDK.\nFor more concrete examples, please refer to:\n* [Simple examples and concepts](https://docs.aperturedata.io/category/simple-usage-examples)\n* [Advanced usage examples](https://docs.aperturedata.io/category/advanced-usage-examples)\n\n# Installing in a custom virtual enviroment\n```bash\npip install aperturedb[complete]\n```\n\nor an installation with only the core part of the SDK\n```bash\npip install aperturedb\n```\n\nA complete [reference](https://docs.aperturedata.io/category/aperturedb-python-sdk) of this SDK is available on the offical [ApertureDB Documentation](https://docs.aperturedata.io)\n\n\n# Development setup\nThe recommended way is to clone this repo, and do an editable install as follows:\n```bash\ngit clone https://github.com/aperture-data/aperturedb-python.git\ncd aperturedb-python\npip install -e .[dev]\n```\n\n\n# Running tests\nThe tests are inside the `test` dir.\n\nAll the tests can be run with:\n\n```bash\nexport GCP_SERVICE_ACCOUNT_KEY=<content of a GCP SERVICE ACCOUNT JSON file>\nbash run_test.sh\n```\n\nRunning specefic tests can be accomplished by invoking it with pytest as follows:\n\n```bash\ncd test && docker compose up -d && PROJECT=aperturedata KAGGLE_username=ci KAGGLE_key=dummy coverage run -m python -m pytest test_Session.py -v --log-cli-level=DEBUG\n```\n\n# Reporting bugs\nAny error in the functionality / documentation / tests maybe reported by creating a\n[github issue](https://github.com/aperture-data/aperturedb-python/issues).\n\n# Development guidelines\nFor inclusion of any features, a PR may be created with a patch,\nand a brief description of the problem and the fix.\nThe CI enforces a coding style guideline with autopep8 and\na script to detect trailing white spaces.\n\nIf a PR encounters failures, the log will describe the location of\nthe offending line with a description of the problem.\n",
"bugtrack_url": null,
"license": "The MIT License @copyright Copyright (c) 2017 Intel Corporation @copyright Copyright (c) 2024 ApertureData 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. ",
"summary": "ApertureDB Python SDK",
"version": "0.4.36",
"project_urls": {
"Bug Reports": "https://github.com/aperture-data/aperturedb-python/issues",
"Homepage": "https://github.com/aperture-data/aperturedb-python"
},
"split_keywords": [
"aperturedb",
" graph",
" database",
" image",
" video",
" metadata",
" search",
" indexing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "026635f46e265eb9ee9506dc2c93c399b2f1d6eacb3b186ac2ba07ab74e6ce57",
"md5": "5d6622578986d7d22cf6ef08eff0e098",
"sha256": "b2adc727651cf11282d44f412575b7a6b31beb1fd298fe2105a5fe8382e80b81"
},
"downloads": -1,
"filename": "aperturedb-0.4.36-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d6622578986d7d22cf6ef08eff0e098",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 124688,
"upload_time": "2024-10-29T21:40:44",
"upload_time_iso_8601": "2024-10-29T21:40:44.368038Z",
"url": "https://files.pythonhosted.org/packages/02/66/35f46e265eb9ee9506dc2c93c399b2f1d6eacb3b186ac2ba07ab74e6ce57/aperturedb-0.4.36-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5190b740afcb270cd24b02fd9ad411340895e4951e41aa0844c72d802905a1d2",
"md5": "c8d55acc7ee94c4f21d0f3a455b4b0ac",
"sha256": "fe1c041aaf10f77c2787adadf759fd642356c749c390e88e04ea0b75de6e608c"
},
"downloads": -1,
"filename": "aperturedb-0.4.36.tar.gz",
"has_sig": false,
"md5_digest": "c8d55acc7ee94c4f21d0f3a455b4b0ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 111294,
"upload_time": "2024-10-29T21:40:46",
"upload_time_iso_8601": "2024-10-29T21:40:46.422726Z",
"url": "https://files.pythonhosted.org/packages/51/90/b740afcb270cd24b02fd9ad411340895e4951e41aa0844c72d802905a1d2/aperturedb-0.4.36.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 21:40:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aperture-data",
"github_project": "aperturedb-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aperturedb"
}
