| Name | aperturedb JSON |
| Version |
0.4.49
JSON |
| download |
| home_page | None |
| Summary | ApertureDB Python SDK |
| upload_time | 2025-08-11 22:10:01 |
| 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 data in and out of ApertureDB in an optimal manner.
A quick [getting started guide](https://docs.aperturedata.io/Setup/QuickStart) is useful to start building with this SDK.
For more concrete examples, please refer to:
* [Simple examples and concepts](https://docs.aperturedata.io/category/start-with-basics)
* [Advanced usage examples](https://docs.aperturedata.io/category/build-ml-examples)
* [Sample applications](https://docs.aperturedata.io/category/build-applications)
# Installing in a custom virtual environment
```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 official [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. Currently these get run in Linux container. Refer to `docker/tests` and `test/run_test_container` for details. Following explanation assumes that the current working directory is `test`.
The tests bring up a set of components in an isolated network, namely:
- aperturedb-community
- lenz
- nginx
- ca (for initial provisioning of certificates)
- webui
To connect to this setup, the ports are exposed to the host as follows:
- 55556 for TCP connection to aperturedb (via lenz).
- 8087 for HTTP connection to aperturedb (via nginx).
This can be done manually as:
```bash
docker compose up -d
```
## Changes to run the tests in development environment.
Edit the file `test/dbinfo.py` to loook like the following.
- DB_TCP_HOST = `localhost`
- DB_REST_HOST = `localhost`
- DB_TCP_PORT = `55556`
- DB_REST_PORT = `8087`
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 specific tests can be accomplished by invoking it with pytest as follows:
```bash
PROJECT=aperturedata KAGGLE_username=ci KAGGLE_key=dummy coverage run -m pytest test_Session.py -v -s --log-cli-level=DEBUG
```
**NOTE:The running environment is assumed to be Linux x86_64. There might be certain changes required for them to be run on MacOS or Windows python environments.**
## Certain Environment variables that affect the runtime beaviour of the SDK.
These can be used as debugging aids.
| Variable | type | Comments | Default value |
| --- | --- | --- | --- |
|ADB_DEBUGGABLE | boolean | allows the application to register a fault handler that dumps a trace when SIGUSR1 is sent to the process | not set |
|LOG_FILE_LEVEL | <a href="https://docs.python.org/3/library/logging.html#logging-levels">log levels</a> | The threshold for emitting log messages into the error<timestamp>.log file | WARN |
|LOG_CONSOLE_LEVEL | <a href="https://docs.python.org/3/library/logging.html#logging-levels">log levels</a> | The threshold for emitting log messages into stdout | ERROR |
|ADB_LOG_FILE | string | custom file path for the LOG file | not set|
# 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/e6/35/ba7143022a3ee19f9571711aab0d25e4aac35c503743da41eed8b8c70e6e/aperturedb-0.4.49.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 data in and out of ApertureDB in an optimal manner.\nA quick [getting started guide](https://docs.aperturedata.io/Setup/QuickStart) 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/start-with-basics)\n* [Advanced usage examples](https://docs.aperturedata.io/category/build-ml-examples)\n* [Sample applications](https://docs.aperturedata.io/category/build-applications)\n\n# Installing in a custom virtual environment\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 official [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. Currently these get run in Linux container. Refer to `docker/tests` and `test/run_test_container` for details. Following explanation assumes that the current working directory is `test`.\n\nThe tests bring up a set of components in an isolated network, namely:\n- aperturedb-community\n- lenz\n- nginx\n- ca (for initial provisioning of certificates)\n- webui\n\n\nTo connect to this setup, the ports are exposed to the host as follows:\n- 55556 for TCP connection to aperturedb (via lenz).\n- 8087 for HTTP connection to aperturedb (via nginx).\n\n\n\nThis can be done manually as:\n```bash\ndocker compose up -d\n```\n\n## Changes to run the tests in development environment.\nEdit the file `test/dbinfo.py` to loook like the following.\n- DB_TCP_HOST = `localhost`\n- DB_REST_HOST = `localhost`\n- DB_TCP_PORT = `55556`\n- DB_REST_PORT = `8087`\n\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 specific tests can be accomplished by invoking it with pytest as follows:\n\n```bash\nPROJECT=aperturedata KAGGLE_username=ci KAGGLE_key=dummy coverage run -m pytest test_Session.py -v -s --log-cli-level=DEBUG\n```\n\n**NOTE:The running environment is assumed to be Linux x86_64. There might be certain changes required for them to be run on MacOS or Windows python environments.**\n\n## Certain Environment variables that affect the runtime beaviour of the SDK.\n\nThese can be used as debugging aids.\n\n| Variable | type | Comments | Default value |\n| --- | --- | --- | --- |\n|ADB_DEBUGGABLE | boolean | allows the application to register a fault handler that dumps a trace when SIGUSR1 is sent to the process | not set |\n|LOG_FILE_LEVEL | <a href=\"https://docs.python.org/3/library/logging.html#logging-levels\">log levels</a> | The threshold for emitting log messages into the error<timestamp>.log file | WARN |\n|LOG_CONSOLE_LEVEL | <a href=\"https://docs.python.org/3/library/logging.html#logging-levels\">log levels</a> | The threshold for emitting log messages into stdout | ERROR |\n|ADB_LOG_FILE | string | custom file path for the LOG file | not set|\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\n \n @copyright Copyright (c) 2017 Intel Corporation\n @copyright Copyright (c) 2024 ApertureData Inc\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"),\n to deal in the Software without restriction,\n including without limitation the rights to use, copy, modify,\n merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in\n all copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\n ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n THE SOFTWARE.\n ",
"summary": "ApertureDB Python SDK",
"version": "0.4.49",
"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": null,
"digests": {
"blake2b_256": "bbb053cd99d784e735119177245e63a4807c0668a7676004881ae947b566dac0",
"md5": "ef317cc05996f0a9a57b38269377d2cc",
"sha256": "a997d3598a1c686e7df72f51fdf5f7d42f640fdb931691f96848160e0cebf30f"
},
"downloads": -1,
"filename": "aperturedb-0.4.49-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef317cc05996f0a9a57b38269377d2cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 141995,
"upload_time": "2025-08-11T22:10:00",
"upload_time_iso_8601": "2025-08-11T22:10:00.130588Z",
"url": "https://files.pythonhosted.org/packages/bb/b0/53cd99d784e735119177245e63a4807c0668a7676004881ae947b566dac0/aperturedb-0.4.49-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e635ba7143022a3ee19f9571711aab0d25e4aac35c503743da41eed8b8c70e6e",
"md5": "abca1031d5dc6c2d8c0b5dfbf858474a",
"sha256": "7cf42950cf1ce5d8b62488ff127a4fea1da76cb64c04747b42b99078cd86d4aa"
},
"downloads": -1,
"filename": "aperturedb-0.4.49.tar.gz",
"has_sig": false,
"md5_digest": "abca1031d5dc6c2d8c0b5dfbf858474a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 129923,
"upload_time": "2025-08-11T22:10:01",
"upload_time_iso_8601": "2025-08-11T22:10:01.803675Z",
"url": "https://files.pythonhosted.org/packages/e6/35/ba7143022a3ee19f9571711aab0d25e4aac35c503743da41eed8b8c70e6e/aperturedb-0.4.49.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 22:10:01",
"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"
}
