Skip to main content

A backtester and spreadsheet library for security analysis.

Project description

pinkfish

A backtester and spreadsheet library for security analysis.

Why another python backtesting library? How is pinkfish different? Simple, I couldn't find a python backtesting library that allowed me to backtest intraday strategies with daily data. Even simple strategies like 'buying on the close' on the SAME day a 'new 20 day high is set' were not allowed. Additionally, I was put off by the complexity of some of the libraries available, and wanted something simple, that doesn't get in the way, and just allows me to test my trading ideas. One user commented that Pinkfish is "very lightweight and to the point". I didn't set out to write a new backtesting library, but I had to. Daily data is free; minute and tick data are typically not. Using minute and tick data can require hours to run vs seconds for daily data.

Some of the key features of pinkfish:

  • leverages pandas for dataframe, spreadsheet like features
  • comes batteries included with the most common technical indicators
  • also integrates with ta-lib or pandas_ta for more advanced indicators
  • leverages matplotlib for making financial graphs
  • uses daily data (vs minute or tick data) for intraday trading
  • uses free daily data from yahoo finance
  • simple to use python API
  • backtest single stock/ETF strategy or a portfolio (basket of stocks/ETFs)
  • backtest short selling strategies and simulate trading with margin
  • write optimizers to select the best parameters
  • create spreadsheets within Jupyter Notebook by utilizing pandas dataframes and itable formatting

Installation

For basic installation of the pinkfish library (not including ta-lib):

# Note: It's recomended to create a new python virtual environment.

$ git clone https://github.com/fja05680/pinkfish.git
$ cd pinkfish
$ python -m venv venv
$ pip install setuptools
$ . venv/bin/activate
$ python setup.py install (or develop)

--OR--

For developer installation with ta-lib, follow the instructions located at:
https://fja05680.github.io/pinkfish/

Examples

Many more examples in examples folder. They are roughly ordered by complexity beginning with the easiest.

Documentation

The pinkfish API documentation: https://fja05680.github.io/pinkfish/docs/html/pinkfish/index.html

Pinkfish on youtube

https://www.youtube.com/channel/UCsPHH2UBn8Fz0g0MGrZ2Ihw

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

pinkfish777-0.1.1.tar.gz (146.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pinkfish777-0.1.1-py3-none-any.whl (106.0 kB view details)

Uploaded Python 3

File details

Details for the file pinkfish777-0.1.1.tar.gz.

File metadata

  • Download URL: pinkfish777-0.1.1.tar.gz
  • Upload date:
  • Size: 146.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.13

File hashes

Hashes for pinkfish777-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5d9f8b0391ed6608bc3aeb671ef8bbb7435348f0defe5ac716b02194ecd55cf4
MD5 2f33d38254444c566709480526c69c30
BLAKE2b-256 2bca1529e17e39777d0e8e02e9323ed0bc3382e8404939e8323b75d30770bf1a

See more details on using hashes here.

File details

Details for the file pinkfish777-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pinkfish777-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8150bff08241d968a2f6ee6b73ab2fa3d35b35b093345c304c32a31191ad9010
MD5 f267589589e82b37066c743aa03dd37a
BLAKE2b-256 cfa8ceeeefcf581b0ff979d0785b36c90c77b6bd4228c3dac4af7d57ebafa291

See more details on using hashes here.

Supported by

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