Skip to main content

A mechanical approach to determine the trend of a stock along with breakout and reversal levels.

Project description

SwingTrend

SwingTrend provides a mechanical approach to determine the stock trend, with breakout and reversal levels.

Python version: >= 3.8

  • Can track trends on historical as well as real-time OHLC data.
  • Use it as a trend indicator or screener.
  • Lightweight and serializable. The Class state can be saved/restored. Useful for day-to-day tracking of trends.
  • Timeframe agnostic - pass data from any timeframe to establish the current trend.
  • Linux, Windows, and Mac. No external dependencies. 90% test coverage of core functionality.

If you ❤️ my work so far, please 🌟 this repo.

👽 Documentation

https://bennythadikaran.github.io/SwingTrend

Installation

pip install swingtrend

Basic Usage (As of v2.0.0)

from swingtrend import Swing`

# Initialise with default values
swing = Swing(
    retrace_threshold_pct=5,
    sideways_threshold=20,
    minimum_bar_count=40,
    debug=False,
)

swing = swing.run(sym="HDFCBANK", df.iloc[-60:])

swing.trend # UP or DOWN or None

swing.is_sideways # True or False.

swing.bars_since # Count of candles since last swing high or low.

swing.is_trend_stable # Is trend accurate, given the number candles supplied?

swing.sph # if trend is UP and SPH is confirmed else None

swing.spl # if trend in DOWN and SPL is confirmed else None

swing.coc # Reversal price for the current trend.

swing.high # the current highest high within a swing.

swing.low # the current lowest low within a swing.

swing.df # A reference to the dataframe passed to Swing.run()

swing.symbol # Symbol name passed to Swing.run()

# Below represent datetime of the respective candles.
swing.sph_dt
swing.spl_dt
swing.coc_dt
swing.high_dt
swing.low_dt

See the documentation for more details.

Inspiration

This work was inspired by youtube channel Matt Donlevey - Photon Trading.

You can watch their video How To Understand Market Structure to understand some of the concepts.

How the class works

See simple explanation of how the program works

To use the Photon method as explained in the video, instantiate the class as Swing(retrace_threshold_pct=None)

With the Photon method, both major or minor pivots can result in trend continuation or reversal. (including a single bar pullback).

I prefer avoiding the minor pivots by setting a minimum threshold percent. With an 8% threshold, the pullback must retrace atleast 8% or more to be considered a level for trend reversal or continuation.

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

swingtrend-2.0.1.tar.gz (256.9 kB view details)

Uploaded Source

Built Distribution

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

swingtrend-2.0.1-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file swingtrend-2.0.1.tar.gz.

File metadata

  • Download URL: swingtrend-2.0.1.tar.gz
  • Upload date:
  • Size: 256.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for swingtrend-2.0.1.tar.gz
Algorithm Hash digest
SHA256 7f1713ae5c9797d42aa4c0f158098792fae069a975b64b78a318899d1e7f57ca
MD5 d2030d12852dedaf4d61e25f88a08b55
BLAKE2b-256 6ce9ab72cd637f029538f9420aa386adce282596ca986dad97e1474b4f7d5455

See more details on using hashes here.

Provenance

The following attestation bundles were made for swingtrend-2.0.1.tar.gz:

Publisher: publish-to-pypi.yml on BennyThadikaran/SwingTrend

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file swingtrend-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: swingtrend-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for swingtrend-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe97ad365701705d8052ad798da00449251eb94fc52fcc612dc49a5cd05dc5dc
MD5 15f277191882377b7e184a0b6d256dde
BLAKE2b-256 04c2720b3ef3b846b6151eab3c5f086e29e0087dcf8c807c78f5a860d1ef9ab4

See more details on using hashes here.

Provenance

The following attestation bundles were made for swingtrend-2.0.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on BennyThadikaran/SwingTrend

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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