Skip to main content

Python Boilerplate contains all the boilerplate you need to create a Python package.

Project description

# swagger_client
Allows to store and return haplotype frequency data

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2017-11-13T05:17:08.843-06:00
- Build package: class io.swagger.codegen.languages.PythonClientCodegen

## Requirements.

Python 2.7 and 3.4+

## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import swagger_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import swagger_client
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi

try:
api_response = api_instance.hfc_get()
pprint(api_response)
except ApiException as e:
print "Exception when calling DefaultApi->hfc_get: %s\n" % e

```

## Documentation for API Endpoints

All URIs are relative to *https://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**hfc_get**](docs/DefaultApi.md#hfc_get) | **GET** /hfc |
*DefaultApi* | [**hfc_population_get**](docs/DefaultApi.md#hfc_population_get) | **GET** /hfc/population |
*DefaultApi* | [**hfc_population_population_id_get**](docs/DefaultApi.md#hfc_population_population_id_get) | **GET** /hfc/population/{populationId} |
*DefaultApi* | [**hfc_post**](docs/DefaultApi.md#hfc_post) | **POST** /hfc |
*DefaultApi* | [**hfc_submission_id_cohort_get**](docs/DefaultApi.md#hfc_submission_id_cohort_get) | **GET** /hfc/{submissionId}/cohort |
*DefaultApi* | [**hfc_submission_id_get**](docs/DefaultApi.md#hfc_submission_id_get) | **GET** /hfc/{submissionId} |
*DefaultApi* | [**hfc_submission_id_haplotypes_get**](docs/DefaultApi.md#hfc_submission_id_haplotypes_get) | **GET** /hfc/{submissionId}/haplotypes |
*DefaultApi* | [**hfc_submission_id_labels_get**](docs/DefaultApi.md#hfc_submission_id_labels_get) | **GET** /hfc/{submissionId}/labels |
*DefaultApi* | [**hfc_submission_id_population_get**](docs/DefaultApi.md#hfc_submission_id_population_get) | **GET** /hfc/{submissionId}/population |
*DefaultApi* | [**hfc_submission_id_scope_get**](docs/DefaultApi.md#hfc_submission_id_scope_get) | **GET** /hfc/{submissionId}/scope |
*PopulationAPIApi* | [**create_population**](docs/PopulationAPIApi.md#create_population) | **POST** /population | Create Population
*PopulationAPIApi* | [**get_all_populations**](docs/PopulationAPIApi.md#get_all_populations) | **GET** /population | Get a list of all populations
*PopulationAPIApi* | [**get_population_for_id**](docs/PopulationAPIApi.md#get_population_for_id) | **GET** /population/{populationId} | Get Population Given an Id


## Documentation For Models

- [AccessData](docs/AccessData.md)
- [CohortData](docs/CohortData.md)
- [Error](docs/Error.md)
- [FrequencyError](docs/FrequencyError.md)
- [Genotype](docs/Genotype.md)
- [GenotypeList](docs/GenotypeList.md)
- [GenotypeMethod](docs/GenotypeMethod.md)
- [HFCurationListResponse](docs/HFCurationListResponse.md)
- [HFCurationRequest](docs/HFCurationRequest.md)
- [HFCurationResponse](docs/HFCurationResponse.md)
- [HaplotypeFrequency](docs/HaplotypeFrequency.md)
- [HaplotypeFrequencyData](docs/HaplotypeFrequencyData.md)
- [Label](docs/Label.md)
- [LabelData](docs/LabelData.md)
- [LabelList](docs/LabelList.md)
- [License](docs/License.md)
- [Method](docs/Method.md)
- [MethodData](docs/MethodData.md)
- [MethodList](docs/MethodList.md)
- [PopulationData](docs/PopulationData.md)
- [PopulationRequest](docs/PopulationRequest.md)
- [PopulationResponse](docs/PopulationResponse.md)
- [PopulationSubmissionData](docs/PopulationSubmissionData.md)
- [PopulationSubmissionResponse](docs/PopulationSubmissionResponse.md)
- [Quality](docs/Quality.md)
- [ResolutionData](docs/ResolutionData.md)
- [ResolutionInfo](docs/ResolutionInfo.md)
- [ScopeData](docs/ScopeData.md)
- [ScopeElement](docs/ScopeElement.md)


## Documentation For Authorization

All endpoints do not require authorization.


## Author





Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for phycus, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size phycus-0.0.1-py2.7.egg (151.8 kB) File type Egg Python version 2.7 Upload date Hashes View hashes
Filename, size phycus-0.0.1-py2.py3-none-any.whl (69.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page