Python client library for VinylDNS
This project is a work in progress! If you would like to help us get this where it needs to be, please reach out to us in gitter.
To run, pip install vinyldns-python and then:
>>> from vinyldns.client import VinylDNSClient
>>> local_client = VinylDNSClient("ApiEndpoint", "UserAccessKey", "UserSecretKey")
>>> local_client.list_zones()
>>>
>>> # If all of the following environments are set
>>> # - VINYLDNS_API_URL
>>> # - VINYLDNS_ACCESS_KEY_ID
>>> # - VINYLDNS_SECRET_ACCESS_KEY
>>> from vinyldns.client import VinylDNSClient
>>> local_client = VinylDNSClient.from_env()
>>> local_client.list_zones()Requirements
python3pipvirtualenv
To get started, you will want to setup your virtual environment.
- Ensure that you have
virtualenvinstalled> pip install virtualenv - Run
./bootstrap.shto setup your environment (unless you really want all these dependencies to be installed locally, which we do not recommend). - Activate your virtual environment
> source .virtualenv/bin/activateand you will be ready to go!
Unit Tests Unit tests are developed using pytest. We use Responses, which allows for simple mocking of HTTP endpoints.
To run unit tests, you can simply run python3 setup.py test. To target a specific test, you can
run python3 setup.py test -a "-k my_test"
Functional Tests Functional tests are also developed with pytest. These tests run against a local instance of VinylDNS. Note that for now they are not tied into our travis build, so they must be run locally for validation.
From your virtualenv, run tox -e func_test
Running a full build
When you are finished writing your code you will want to run everything including linters. The
simplest way to do this is to run tox -e check,py36, which will run static checks and run unit tests.
If you see any failures / warnings, correct them until tox runs successfully.
If you do not have tox in your environment, pip install tox to add it. For more information you can
read the tox docs.
See the quickstart in the VinylDNS api for details on how to start up a local instance of the api in docker. With that running, you can make requests with the following client details:
local_client = VinylDNSClient("http://localhost:9000", "okAccessKey", "okSecretKey")