Skip to main content

Backtest engine for algorithmic trading

Project description

======== Backtest

.. image:: https://img.shields.io/pypi/pyversions/backtest.svg :target: https://pypi.org/project/backtest/ :alt: Python

.. image:: https://img.shields.io/pypi/v/backtest.svg :target: https://pypi.org/project/backtest/ :alt: PyPi

.. image:: https://github.com/yoonbae81/backtest/workflows/test/badge.svg :target: https://github.com/yoonbae81/backtest/actions?query=workflow%3Atest :alt: Test

.. image:: https://github.com/yoonbae81/backtest/workflows/build/badge.svg :target: https://github.com/yoonbae81/backtest/actions?query=workflow%3Abuild :alt: Build

.. image:: https://codecov.io/gh/yoonbae81/backtest/graph/badge.svg :target: http://codecov.io/gh/yoonbae81/backtest :alt: Coverage

.. image:: https://readthedocs.org/projects/backtest/badge/?version=latest :target: https://backtest.readthedocs.io/latest :alt: Docs

.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg :target: https://www.gnu.org/licenses/gpl-3.0 :alt: License: GPL v3

Overview

Backtest is a backtesting_ engine for developing algorithmic trading strategy.

.. _backtesting: https://en.wikipedia.org/wiki/Backtesting

Requirements

  • Python <https://www.python.org/>__ 3.9
  • Numpy <https://numpy.org/>__ 1.18.0
  • Requests <https://requests.readthedocs.io/>__ 2.23.0

Installation

The quick way:

.. code:: bash

$ pip install backtest

See the install section in the documentation at https://backtest.readthedocs.io/en/latest/intro/install.html for more details.

Preparation

Fetching symbols of KOSPI and KOSDAQ exchanges:

.. code:: bash

$ python -m backtest.utils.symbols_krx symbols.json
Fetched 2,820 symbols
Saved in symbols.json

Documentation

Documentation is available online_ and in the docs directory. (also in 한국어_)

.. _online: https://backtest.readthedocs.io/en/latest/ .. _한국어: https://backtest.readthedocs.io/ko/latest/

Support

Please open an issue <https://github.com/yoonbae81/backtest/issues/new>__ for support.

Contributing

Please contribute using Github Flow <https://guides.github.com/introduction/flow/>. Create a branch, add commits, and open a pull request <https://github.com/yoonbae/backtest/compare/>.

Project details


Download files

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

Source Distribution

backtest-0.7.7.tar.gz (16.9 kB view hashes)

Uploaded Source

Built Distribution

backtest-0.7.7-py3-none-any.whl (33.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page