Metadata-Version: 2.1
Name: montagu
Version: 0.0.3
Summary: Python client for Montagu API
Home-page: https://github.com/vimc/montagu-py
Author: Emma Russell
Author-email: e.russell@imperial.ac.uk
License: MIT
Description: # montagu-py
        
        [![Build Status](https://travis-ci.com/vimc/montagu-py.svg?branch=master)](https://travis-ci.com/vimc/montagu-py)
        [![codecov.io](https://codecov.io/github/vimc/montagu-py/coverage.svg?branch=master)](https://codecov.io/github/vimc/montagu-py?branch=master)
        
        Python client for [Montagu API](https://github.com/vimc/montagu-api). 
        
        Initial use case is for authentication only.
        
        ## Usage
        
        The client currently supports authenticating with Montagu, and a single example endpoint.
        
        To authenticate, instantiate the `MontaguAPI` class, providing base url, username and password as parameters:
        
        ```
        api = MontaguAPI('http://localhost:8080', 'test.user@example.com', 'password')
        ```
        
        The Montagu authentication token can be accessed on the api object: 
        ```
        token = api.token
        ```
        
        The example endpoint returns a list of all diseases:
        ```
        diseases = api.diseases()
        ```
        
        ## Development
        
        Clone the repo anywhere and install dependencies with (from the repo root):
        
        ```
        pip3 install --user -r requirements.txt
        ```
        
        Run dependencies (a local copy of Montagu API and database) with `scripts/run-dev-dependencies.sh`. This will also
        add a test user to Montagu.
        
        ## Testing
        
        Run dependencies as described above, then run `pytest`
        
        ## Publishing
        
        This repository is published to [PyPI](https://pypi.org/). 
        
        Building and publishing is done manually, with local sources. 
        See general instructions for publishing Python packages [here](https://packaging.python.org/tutorials/packaging-projects/).
        
        Publishing configuration can be found in `setup.py`. Remember to increment `version` when publishing a new build.
        
        Some troubleshooting tips for publishing Python packages can be found in the 
        [consellations repo](https://github.com/reside-ic/constellation/blob/master/publish.md).
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
