Skip to main content

"Developer toolkit for IBD CANSLIM practitioners"

Project description

canswim

Developer toolkit for CANSLIM investment style practitioners

Setup

pip install canswim

Install canswim package in dev mode

pip install -e ./

Command line interface

$ python -m canswim -h
usage: canswim [-h] {dashboard,train}

CANSWIM is a toolkit for CANSLIM style investors. Aims to complement the Simple Moving Average and other technical indicators.

positional arguments:
  {dashboard,gatherdata,uploaddata,modelsearch,train,finetune,forecast}
                        Which canswim task to run:
                        `dashboard` for stock charting and scans of recorded forecasts.
                        'gatherdata` to gather 3rd party stock market data and save to HF Hub.
                        'uploaddata` upload to HF Hub any interim changes to local data storage.
                        `modelsearch` to find and save optimal hyperparameters for model training.
                        `train` for continuous model training.
                        `finetune` to fine tune pretrained model on new stock market data. `forecast` to run forecast on stocks and upload dataset to HF Hub.

options:
  -h, --help            show this help message and exit
  --forecast_start_date FORECAST_START_DATE
                        Optional argument for the `forecast` task. Indicate forecast start date in YYYY-MM-DD format. If not specified, forecast will start from the end of the target series.

NOTE: NOT FINANCIAL OR INVESTMENT ADVICE. USE AT YOUR OWN RISK.

Interactive Dashboard hosted on Hugging Face Hub

https://huggingface.co/spaces/ivelin/canswim_playground

canswim playground

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

canswim-0.0.8.tar.gz (43.8 kB view hashes)

Uploaded Source

Built Distribution

canswim-0.0.8-py3-none-any.whl (46.6 kB view hashes)

Uploaded Python 3

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