canswim


Namecanswim JSON
Version 0.0.8 PyPI version JSON
download
home_page
Summary"Developer toolkit for IBD CANSLIM practitioners"
upload_time2024-03-05 19:25:33
maintainer
docs_urlNone
authorIvelin Ivanov
requires_python>=3.10
licenseApache-2.0
keywords stock market analytics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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](https://github.com/ivelin/canswim/assets/2234901/26fb1a5d-49e0-4888-bc1b-042800bcef8f)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "canswim",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "stock market,analytics",
    "author": "Ivelin Ivanov",
    "author_email": "ivelin117@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/dd/55/c8a0fe6fa3481a3129c619e3a501c94d68f8f866f5486216c0798a26848c/canswim-0.0.8.tar.gz",
    "platform": null,
    "description": "# canswim\nDeveloper toolkit for CANSLIM investment style practitioners\n\n\n# Setup\n\n\n```\npip install canswim\n```\n\n\n## Install canswim package in dev mode\n\n```\npip install -e ./\n```\n\n## Command line interface\n\n```\n$ python -m canswim -h\nusage: canswim [-h] {dashboard,train}\n\nCANSWIM is a toolkit for CANSLIM style investors. Aims to complement the Simple Moving Average and other technical indicators.\n\npositional arguments:\n  {dashboard,gatherdata,uploaddata,modelsearch,train,finetune,forecast}\n                        Which canswim task to run:\n                        `dashboard` for stock charting and scans of recorded forecasts.\n                        'gatherdata` to gather 3rd party stock market data and save to HF Hub.\n                        'uploaddata` upload to HF Hub any interim changes to local data storage.\n                        `modelsearch` to find and save optimal hyperparameters for model training.\n                        `train` for continuous model training.\n                        `finetune` to fine tune pretrained model on new stock market data. `forecast` to run forecast on stocks and upload dataset to HF Hub.\n\noptions:\n  -h, --help            show this help message and exit\n  --forecast_start_date FORECAST_START_DATE\n                        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.\n\nNOTE: NOT FINANCIAL OR INVESTMENT ADVICE. USE AT YOUR OWN RISK.\n```\n\n## Interactive Dashboard hosted on Hugging Face Hub\n\n\nhttps://huggingface.co/spaces/ivelin/canswim_playground\n\n![canswim playground](https://github.com/ivelin/canswim/assets/2234901/26fb1a5d-49e0-4888-bc1b-042800bcef8f)\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "\"Developer toolkit for IBD CANSLIM practitioners\"",
    "version": "0.0.8",
    "project_urls": null,
    "split_keywords": [
        "stock market",
        "analytics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f198ff5837d62890f158cae104c2c71c9106b4eaf5207bbdfed07c5e01bcb204",
                "md5": "d90a791151eff24b354b1b313243f60e",
                "sha256": "06e31291e8e25556fabd8ee478bfa95c1625c4053f637d1194ac4b4b967fb7bf"
            },
            "downloads": -1,
            "filename": "canswim-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d90a791151eff24b354b1b313243f60e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 46611,
            "upload_time": "2024-03-05T19:25:31",
            "upload_time_iso_8601": "2024-03-05T19:25:31.315265Z",
            "url": "https://files.pythonhosted.org/packages/f1/98/ff5837d62890f158cae104c2c71c9106b4eaf5207bbdfed07c5e01bcb204/canswim-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd55c8a0fe6fa3481a3129c619e3a501c94d68f8f866f5486216c0798a26848c",
                "md5": "503590cace2626e1c3bee127622c4b5a",
                "sha256": "6658e21de1eceeb9701891edab88188acf7b604de011c502af729f07dd427e4c"
            },
            "downloads": -1,
            "filename": "canswim-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "503590cace2626e1c3bee127622c4b5a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 43754,
            "upload_time": "2024-03-05T19:25:33",
            "upload_time_iso_8601": "2024-03-05T19:25:33.019454Z",
            "url": "https://files.pythonhosted.org/packages/dd/55/c8a0fe6fa3481a3129c619e3a501c94d68f8f866f5486216c0798a26848c/canswim-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-05 19:25:33",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "canswim"
}
        
Elapsed time: 0.20958s