Skip to main content

Intelligent Stock Screening for Informed Investment Decisions

Project description

PyStockFilter

Release Build CI Build PyPI - Downloads Coverage Status Codacy Badge

PyStockFilter is a Python library that allows users to create custom stock filters using a range of fundamental and technical indicators. With support for data sources like Yahoo Finance, local data, and pystockdb, PyStockFilter is a versatile solution for building and backtesting technical and fundamental trading strategies.

Features

  • Data Compatibility: Integrates with Yahoo Finance, local data, and pystockdb.
  • Built-in Indicators: Includes essential technical indicators, and supports custom indicator creation.
  • Backtesting: Enables testing of strategies on historical data.
  • Optimization Tools: Offers parameter optimization, including sequential and chunked data optimization.
  • Custom Strategy Support: Extendable with your own strategies and indicators.

Built-in Filters

Technical Filters

PyStockFilter includes several popular technical indicators, which can be used out of the box or customized:

  • Simple Moving Average (SMA)
  • Exponential Moving Average (EMA)
  • Relative Strength Index (RSI)
  • Ultimate Oscillator (UO)
  • Moving Average Convergence Divergence (MACD)
  • Bollinger Bands (BB)

For custom indicators, refer to the examples in the src/pystockfilter/strategy directory.

Installation

To install PyStockFilter, run:

pip install pystockfilter

Quick Start Guide

For detailed examples on setting up strategies, defining parameters, and running the optimizer, please visit the Examples Directory in the PyStockFilter repository.

Issue Tracker

Report issues, request features, or contribute via the GitHub Issue Tracker:

PyStockFilter Issue Tracker

Disclaimer

This software is for educational purposes only. Do not risk money which you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pystockfilter-2.3.1-py3-none-any.whl (76.6 kB view details)

Uploaded Python 3

File details

Details for the file pystockfilter-2.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pystockfilter-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 77142068bfe0f5211707342ae78116f4363cfe48c57e6c196a7e4601ccdefb68
MD5 adfc25fffddd3e644d567a39f066b4cf
BLAKE2b-256 5f896753ad1b5d670e4d52f27385c876f3f2686dd90debd1cdf2ed431a525626

See more details on using hashes here.

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