Metadata-Version: 2.0
Name: backtrader-contrib
Version: 0.0.1
Summary: Contributions to the backTesting engine
Home-page: https://github.com/mementum/backtrader_contrib
Author: Daniel Rodriguez
Author-email: danjrod@gmail.com
License: GPLv3+
Download-URL: https://github.com/mementum/backtrader_contrib/tarball/0.0.1
Keywords: trading,development
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Software Development
Classifier: Topic :: Office/Business :: Financial
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: OSI Approved :: BSD License
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent


backtrader_contrib
==================

.. image:: https://img.shields.io/pypi/v/backtrader.svg
   :alt: PyPi Version
   :scale: 100%
   :target: https://pypi.python.org/pypi/backtrader_contrib/

.. image:: https://img.shields.io/pypi/pyversions/backtrader.svg
   :alt: Python versions
   :scale: 100%
   :target: https://pypi.python.org/pypi/backtrader_contrib/

Features:
=========

This is the repostory for foreign contributions to ``backtrader``.

Pull Requests can be accepted with the following LICENSES:

  - GPLv3
  - MIT
  - BSD 3-Clause
  - Apache 2.0

How does it work
================

The package will scan ``.py`` file inside the corresponding subpackages (like
``analyzers``, ``indicators``, etc) and will import the classes which are
subclasses of the corresponding subpackages (``Analyzer``, ``Indicator``)

Errors will be silently ignored

Successfully imported elements will be added to the corresponding subpackage of
``backtrader``. I.e.: anything inside ``backtrader_contrib.indicators`` will be
monkey-patched (added) to ``backtrader.indicators``

The package will auto-replace itself and return ``backtrader``

Usage
=====

As simple as::

  import backtrader_contrib as bt

And carry on using ``bt`` as if you had directly imported *backtrader*


