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.260904.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.260904.0
File Size Uploaded
pyoaev-3.260904.0.tar.gz 91.0 kB Details

Built distribution (wheel)

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

Total release size: 212.1 kB

Release files / pyoaev-3.260904.0.tar.gz

Download URL pyoaev-3.260904.0.tar.gz
Size 91.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e19659c9bea417fcf92d034d021dbd695488357eb99a7d31711d63ee77fde894
BLAKE2b-256 checksum
How to use checksums
60fd4c7a28c708044840acdf1f9c1ab015193e48536f5527f5cca58fc6c44a4b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

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

Download URL pyoaev-3.260904.0-py3-none-any.whl
Size 121.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
723e7f44ca05399d36b141d2885fc150ab58bd5c920d063888f99db80757dfea
BLAKE2b-256 checksum
How to use checksums
c9beb5915874c903880908dd7974591f99a5b9225f30731219632442f18485d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Release history Release notifications | RSS feed

This release

3.260904.0 This release

2 release files

2.4.0

2 release files

2.3.5

2 release files

2.3.4

2 release files

2.3.3

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.8

2 release files

2.1.7

2 release files

2.1.6

2 release files

2.1.5

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.14

2 release files

2.0.13

2 release files

2.0.12

2 release files

2.0.9

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

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