Skip to main content

OpenAEV client for Python

Website CircleCI readthedocs GitHub release Number of PyPI downloads Slack Status

The official OpenAEV Python client helps developers to use the OpenAEV API by providing easy to use methods and utils. This client is also used by some OpenAEV components.

Install

To install the latest Python client library, please use pip:

$ pip3 install pyoaev

Local development

# Fork the current repository, then clone your fork
$ git clone https://github.com/YOUR-USERNAME/client-python
$ cd client-python
$ git remote add upstream https://github.com/OpenAEV-Platform/client-python.git
# Create a branch for your feature/fix
$ git checkout -b [branch-name]
# Create a virtualenv
$ python3 -m venv .venv
$ source .venv/bin/activate
# Install the client-python and dependencies for the development and the documentation
$ python3 -m pip install -e .[dev,doc]
# Set up the git hook scripts
$ pre-commit install
# Create your feature/fix
# Create tests for your changes
$ python -m pytest
# Push you feature/fix on Github
$ git add [file(s)]
$ git commit -m "[descriptive message]"
$ git push origin [branch-name]
# Open a pull request

Install the package locally

$ pip install -e .

Documentation

Client usage

To learn about how to use the OpenAEV Python client and read some examples and cases, refer to the client documentation.

API reference

To learn about the methods available for executing queries and retrieving their answers, refer to the client API Reference.

Tests

The pytest library is used for running the tests.

$ python -m pytest

Code Coverage

To run the tests and generate a code coverage report:

pytest --cov=. tests/

About

OpenAEV is a product designed and developed by the company Filigran.

Metadata

Release files for pyoaev 3.261027.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyoaev 3.261027.0
File Size Uploaded Provenance
pyoaev-3.261027.0.tar.gz 115.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyoaev 3.261027.0
File Interpreter ABI Platform
pyoaev-3.261027.0-py3-none-any.whl Python 3 none any Details

Total release size: 269.1 kB

Release files / pyoaev-3.261027.0.tar.gz

Download URL pyoaev-3.261027.0.tar.gz
Size 115.6 kB
Tags Source
SHA-256 checksum
How to use checksums
254c1f47fce699723e3fc0cd02c68685a32b488547ea5436232faadb463b9aa1
BLAKE2b-256 checksum
How to use checksums
0b681751cf76fdaeb4b3bd34989e27da401240a09791158a1b4a1782d3a8e1ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Release files / pyoaev-3.261027.0-py3-none-any.whl

Download URL pyoaev-3.261027.0-py3-none-any.whl
Size 153.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
83cf0a7c5584f8335854c5f6ccb26cb8e8c508d3ac0a9e4c68cdb3d9b6344050
BLAKE2b-256 checksum
How to use checksums
a2ebf36d3a6f4daee172088f8438f38b6f566be26e7a2162d846abfbc0c45bcc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Security for pyoaev 3.261027.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.261027.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page