An interface for a Python 3+ client to interact with the Adnuntius Advertising and Data APIs.
You will need to have virtualenv installed. On mac this can be done via brew install virtualenv for example.
Once you have checked out the project, you should change directory into it (cd api-tools) and then setup and
activate a virtual environment to contain the dependencies of this project. For example in linux at the top
level directory of this project, you would do:
virtualenv .venv
source .venv/bin/activate
Once the virtualenv is active, the simplest way to install the latest production release is via pip
pip3 install adnuntius
All production (not pre-release) releases from this repository are available in Pypi for installation via pip.
As an alternative to the last command, you can select a particular version in pip with the == operator,
for example pip3 install adnuntius==1.16.1
Note that semantic versioning is used for production releases, so major versions indicate incompatible API changes, minor versions indication additions to the api, and patch versions indicate backwards compatible bug fixes.
For non-production releases you can download and extract the tarball and use the following commands to install
python3 setup.py build
python3 setup.py install
A good way to get started is to look at test/example_line_item.py.
To see this in action fist run python3 -m test.example_line_item -h to list the arguments you need.
If you prefer to run in an IDE, an "ExampleLineItem" launcher is included to run it in IntelliJ IDEA and PyCharm.
python3 setup.py sdist bdist_wheel
A test suite is run via github actions on every push.
It can be executed manually via python3 -m test.test_adnuntius or the "TestAdnuntius" launcher if you have python 3.8+
The flake8 linter is run via github actions on every push.
It can be installed via pip (pip install flake8) and run manually.
The build stopping errors can be seen with flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics.
The warnings can be seen with flake8 . --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics