This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
# Quantopian Tools

> This project is not supported nor endorsed by [Quantopain](https://www.quantopian.com).

[![Build Status](https://img.shields.io/travis/Gitlitio/quantopian-tools.svg)](https://travis-ci.org/Gitlitio/quantopian-tools)
[![Docs Status](https://readthedocs.org/projects/quantopian-tools/badge/?version=latest)](http://quantopian-tools.readthedocs.io/en/latest/)
[![PyPi Version](https://img.shields.io/pypi/v/quantopian-tools.svg)](https://pypi.python.org/pypi/quantopian-tools/)
[![Downloads](https://img.shields.io/pypi/dm/quantopian-tools.svg)](https://pypi.python.org/pypi/quantopian-tools/)
[![GitHub release](https://img.shields.io/github/release/Gitlitio/quantopian-tools.svg)](https://github.com/Gitlitio/quantopian-tools/releases)
[![Requires.io](https://img.shields.io/requires/github/Gitlitio/quantopian-tools.svg)](https://requires.io/github/Gitlitio/quantopian-tools/requirements/?branch=master)
[![Codecov](https://img.shields.io/codecov/c/github/Gitlitio/quantopian-tools.svg)](https://codecov.io/gh/Gitlitio/quantopian-tools)
[![GitHub issues](https://img.shields.io/github/issues/Gitlitio/quantopian-tools.svg)](https://github.com/Gitlitio/quantopian-tools/issues)
[![license](https://img.shields.io/github/license/Gitlitio/quantopian-tools.svg)](https://github.com/Gitlitio/quantopian-tools/blob/master/LICENSE)


***

#### This project is alpha and is actively being developed.

***

A collection of functions for automating actions on the Quantopian trading platform.


## Installation

```bash
pip install quantopian-tools
```

Or to manually install, execute the following commands:

```bash
git clone https://github.com/Gitlitio/quantopian-tools.git
cd quantopian-tools
python setup.py install
```
***

## Documentation

Check out our documentation on [readthedocs](http://quantopian-tools.readthedocs.io/en/latest/)


## Development

### Makefile Targets

> Makefile commands will only work inside a [virtualenv](https://virtualenv.pypa.io/en/latest/) or a
[condaenv](http://conda.pydata.org/docs/using/envs.html)

#### `make init`

Initializes the virtualenv with an up-to-date version of setuptools, pip, and
[pip-tools](https://github.com/nvie/pip-tools/)

#### `make install`

Runs [pip-compile] with `requirements/py<current interpreter="" version="">.txt` and produces a compiled requirement file in
the `.cache` directory . The [pip-sync] is ran with the newly compiled requirements file. This makes sure you are
running with the latest release of dependencies, assuming you haven't pinned them in the
`requirements/py<current interpreter="" version="">.txt` file.

#### `make lint`

Runs [pylint] and [pep8] on all packages in the project directory.

#### `make test`

Runs [py.test] tests located inside the tests/ folder and any test files nested in a package in the project directory.
Coverage is only calculated in this target.

#### `make test-unit`

Same as `make test` excluding coverage and tests marked as `integration`.

#### `make test-integration`

Same as `make test` excluding coverage and tests **not** marked as `integration`.

#### `make build`

Builds a wheel using setuptools' bdist_wheel command. Locally builds are tagged with dev (ex 0.1.0+dev). In the travis
build environment the wheel is tagged with the job number (ex. 0.1.0+build1.1).

#### `make clean`

Cleans the project of compiled python files and files generated by the above commands such as build and dist directories.

---
Copyright 2016 Gitlit. Licensed under the 3-clause BSD. See [LICENSE](LICENSE).

[pylint]: https://www.pylint.org/
[pep8]: https://pep8.readthedocs.io/en/latest/
[py.test]: http://pytest.org/latest/
[pip-tools]: https://github.com/nvie/pip-tools/#pip-tools--pip-compile--pip-sync
[pip-compile]: https://github.com/nvie/pip-tools/#example-usage-for-pip-compile
[pip-sync]: https://github.com/nvie/pip-tools/#example-usage-for-pip-sync



Copyright (c) 2016, Gitlit
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of quantopian-tools nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Release History

Release History

0.0.1a0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
quantopian_tools-0.0.1a0-py27-none-any.whl (15.9 kB) Copy SHA256 Checksum SHA256 py27 Wheel Sep 10, 2016
quantopian-tools-0.0.1a0.tar.gz (10.3 kB) Copy SHA256 Checksum SHA256 Source Sep 10, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting