Metadata-Version: 2.2
Name: aperturedb
Version: 0.4.43
Summary: ApertureDB Python SDK
Author-email: ApertureData Engineering <team@aperturedata.io>
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.
        
Project-URL: Homepage, https://github.com/aperture-data/aperturedb-python
Project-URL: Bug Reports, https://github.com/aperture-data/aperturedb-python/issues
Keywords: aperturedb,graph,database,image,video,metadata,search,indexing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: protobuf<6.0.0,>=3.20.3
Requires-Dist: scikit-image
Requires-Dist: image
Requires-Dist: requests
Requires-Dist: boto3
Requires-Dist: numpy<2; python_version < "3.9.0"
Requires-Dist: numpy
Requires-Dist: distributed
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: kaggle!=1.6.15
Requires-Dist: google-cloud-storage
Requires-Dist: ipython
Requires-Dist: dask[complete]
Requires-Dist: ipywidgets
Requires-Dist: pydantic>=2.6.0
Requires-Dist: devtools
Requires-Dist: typer
Requires-Dist: opencv-python-headless
Requires-Dist: grpcio-status==1.48.2
Requires-Dist: ipywidgets==8.0.4
Requires-Dist: keepalive-socket==0.0.1
Requires-Dist: graphviz==0.20.2
Requires-Dist: python-dotenv
Provides-Extra: notebook
Requires-Dist: torch; extra == "notebook"
Requires-Dist: torchvision; extra == "notebook"
Requires-Dist: tensorflow; extra == "notebook"
Requires-Dist: facenet-pytorch; extra == "notebook"
Provides-Extra: complete
Requires-Dist: torch; extra == "complete"
Requires-Dist: torchvision; extra == "complete"
Requires-Dist: tensorflow; extra == "complete"
Requires-Dist: facenet-pytorch; extra == "complete"
Provides-Extra: dev
Requires-Dist: torch; extra == "dev"
Requires-Dist: torchvision; extra == "dev"
Requires-Dist: tensorflow; extra == "dev"
Requires-Dist: facenet-pytorch; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: autopep8; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: fuse-python; platform_system == "Linux" and extra == "dev"
Requires-Dist: rdflib; extra == "dev"

# 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 specific 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 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.
