https://github.com/digidotcom/python-wvalib
Python library and CLI for accessing WVA functions
https://github.com/digidotcom/python-wvalib
Last synced: 5 months ago
JSON representation
Python library and CLI for accessing WVA functions
- Host: GitHub
- URL: https://github.com/digidotcom/python-wvalib
- Owner: digidotcom
- License: mpl-2.0
- Created: 2015-03-31T19:47:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-22T23:32:25.000Z (over 6 years ago)
- Last Synced: 2025-09-23T00:16:03.106Z (10 months ago)
- Language: Python
- Size: 287 KB
- Stars: 5
- Watchers: 39
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README-dev.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Developer's Guide
=================
For general documentation for this library, plese refer to
[README.md](README.md). The content here is targetted for
developer's looking to make changes to the code itself.
Please note that this library is licensed under the terms of the MPL
v2.0, so you are free to make changes to the library without having to
contribute those changes back (see https://www.mozilla.org/MPL/2.0/).
That being said, contributions are welcome and would be greatly
appreciated.
Setting up your development environment
---------------------------------------
We recommend that developer's use
[virtualenv](https://virtualenv.pypa.io/en/latest/) and
[pip](https://pypi.python.org/pypi/pip) for development. With those
tools installed and the code checked out, the following can be done to
get a basic development environment set up (under Linux). The same
basic instructions should apply to any OS but may require some tweaks:
```
$ virtualenv env
$ source env/bin/activate
$ pip install -r dev-requirements.txt
```
The last line will install all requirements for both the library and
dependencies for running the tests.
Running the Tests
-----------------
The quickest way to run the unittests for the library is to do the
following (with your virtualenv activiated):
```
$ nosetests .
```
As the library supports multiple versions of the interpreter, there is
also a script included which aids in testing the code against all
supported versions of the interpreter. This script makes use of
[pyenv](https://github.com/yyuu/pyenv) and
[tox](https://tox.readthedocs.org/en/latest/). This testing script is
only supported under Linux. Since pyenv must download and build all
required interpreters from source, it may take quite a while to run
the first time.
```
$ ./toxtests.sh
```
If you run into problems, you may need to install some additional
dependencies as described
[in the pyenv documentation](https://github.com/yyuu/pyenv/wiki/Common-build-problems).
Once you have run toxtests.sh successfully once, you can quickly test
with a specific version of the interpreter by running nosetests out of
the tox environment for the desired version of the interpreter:
```
$ .tox/py34/bin/nosetests .
```
Coding Standards
----------------
All contributions to the library must comply with the style guidelines
documented in [PEP8](https://www.python.org/dev/peps/pep-0008/). The
[pep8 checker](https://pypi.python.org/pypi/pep8) may be used to
ensure that problems are found prior to code review.