swingtrend 2.0.2.post1

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

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.1`)

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.leg_count # Number of swing legs, the trend has completed.

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.