# Quantopian Tools
> This project is not supported nor endorsed by [Quantopain](https://www.quantopian.com).
#### This project is alpha and is actively being developed.
A collection of functions for automating actions on the Quantopian trading platform.
pip install quantopian-tools
Or to manually install, execute the following commands:
git clone https://github.com/Gitlitio/quantopian-tools.git
python setup.py install
Check out our documentation on [readthedocs](http://quantopian-tools.readthedocs.io/en/latest/)
### Makefile Targets
> Makefile commands will only work inside a [virtualenv](https://virtualenv.pypa.io/en/latest/) or a
#### `make init`
Initializes the virtualenv with an up-to-date version of setuptools, pip, and
#### `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).
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.
TODO: Brief introduction on what you do with files - including link to relevant help section.