Skip to content

analyzere/analyzere-python

Repository files navigation

Analyze Re Python Client

This is a Python wrapper for a Analyze Re REST API. It allows you to easily utilize the PRIME Re platform in your applications.

Installation

pip install analyzere

Usage

Please see http://docs.analyzere.net/?python for the most up-to-date documentation.

Testing

We currently commit to being compatible with Python 2.7 and Python 3.4. In order to run tests against against each environment we use tox and py.test. You'll need an interpreter installed for each of the versions of Python we test. You can find these via your system's package manager or on the Python site.

To start, install tox:

pip install tox

Then, run the full test suite:

tox

To run tests for a specific module, test case, or single test, you can pass arguments to py.test through tox with --. E.g.:

tox -- tests/test_base_resources.py::TestReferences::test_known_resource

See tox --help and py.test --help for more information.

Publishing

  1. Install twine and wheel:

    pip install twine wheel
    
  2. Increment version number in setup.py according to PEP 440.

  3. Register the package:

    python setup.py register
    
  1. Package source and wheel distributions:

    python setup.py sdist bdist_wheel
    
  2. Upload to PyPI with twine:

    twine upload dist/*