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.260917.1

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.260917.1
File Size Uploaded
pyoaev-3.260917.1.tar.gz 91.1 kB Details

Built distribution (wheel)

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

Total release size: 212.2 kB

Release files / pyoaev-3.260917.1.tar.gz

Download URL pyoaev-3.260917.1.tar.gz
Size 91.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4829b533003f354646085dc69681569799e3d87fa940eb781b274b30b55e06c6
BLAKE2b-256 checksum
How to use checksums
8490b079f9771aec71f0bbba035aa4f42997c4e67aa99f20e834803e384883a8
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.260917.1-py3-none-any.whl

Download URL pyoaev-3.260917.1-py3-none-any.whl
Size 121.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
387375d132d5724a6ed801e712f333b6c91561902907f2f67fe48e255270ecc0
BLAKE2b-256 checksum
How to use checksums
ca030f19ddc1cdcd921149d03ead3348d8bb728da29a53aaf263a5f12e25f793
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.260917.1 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