Skip to main content

Add your description here

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.3.tar.gz (147.1 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.3-py3-none-any.whl (106.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pinkfish777-0.1.3.tar.gz
  • Upload date:
  • Size: 147.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pinkfish777-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c4635b1d8f71c41bd6bca0aa6b029308402a9d8e849a2c7c15ce0d17256632ec
MD5 c416e579cd705ff7b52cef59669937a2
BLAKE2b-256 f861b63b40c9f104fa13f911707c37e3482f48ac9b87c8f47634deebf149b805

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pinkfish777-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 106.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pinkfish777-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0c2f3a83f2114ba577621b99c33aeb0a7025c36087e24e1a9c755ab49f588c90
MD5 f2c6c1482a730aae3fa858b88f2142dc
BLAKE2b-256 169c94a148950b96d69d932f68b1aa2e087dba6b8fb075492a0bd7a6da01da96

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