Git Product home page Git Product logo

analyzere-python's Introduction

Analyze Re Python Client Travis-CI Build Status

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. 3.4, 3.5, and 3.6. 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.

Tagging

  1. Install twine and wheel:

    pip install twine wheel
  2. Increment version number in setup.py according to PEP 440.
  3. Increment the version number in the user_agent variable in analyzere/__init__.py.
  4. Commit your change to setup.py and create a tag for it with the version number. e.g.:

    git tag 0.5.1
    git push origin 0.5.1

.pypirc file

Create a .pypirc file with your production and test server accounts in your HOME directory. This file should look as follows:

[distutils]
index-servers=
    pypi
    testpypi

[testpypi]
repository = https://test.pypi.org/legacy/
username = <username>
password = <password>

[pypi]
repository = https://upload.pypi.org/legacy/
username = <username>
password = <password>

Note that testpypi and pypi require separate registration.

Testing Publication

1. Ensure you have tagged the master repository according to the tagging instructions above.

  1. Package source and wheel distributions:

    python setup.py sdist bdist_wheel
  2. Check format:

    twine check dist/*
  3. Upload to PyPI with twine:

    twine upload dist/* -r testpypi
  4. Test that you can install the package from testpypi:

    pip install -i https://testpypi.python.org/pypi analyzere

Publishing

1. Ensure you have tagged the master repository according to the tagging instructions above, testing publication before publication.

  1. Package source and wheel distributions:

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

    twine upload dist/* -r pypi

analyzere-python's People

Contributors

ajsteadly avatar almabekov avatar bmacphee avatar danielarndt avatar dwil avatar fishflavored avatar hanz-analyzere avatar karlrl avatar mcgillij avatar obaltzer avatar oeuftete avatar pmdarrow avatar sbchisholm avatar sbmacdonald avatar vlad-maksymiv avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.