canswim


Namecanswim JSON
Version 0.0.20250106 PyPI version JSON
download
home_pageNone
Summary"Developer toolkit for CANSLIM investment style practitioners"
upload_time2025-01-05 18:34:03
maintainerNone
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

For a brief introduction read [this blog post](https://medium.com/@ivelin.atanasoff.ivanov/canswim-a-deep-learning-tool-for-canslim-practitioners-2c9740bb0d3d).

[Here is also a video recording](https://www.youtube.com/watch?v=GfC-H0uxXvk&ab_channel=AustinPythonMeetup) of a CANSWIM presentation for the [Python Austin Meetup](https://www.meetup.com/austinpython/).

# Setup


```
pip install canswim
```


## Install canswim package in dev mode

```
pip install -e ./
```

## Command line interface

```
$  python -m canswim -h
usage: canswim [-h] [--forecast_start_date FORECAST_START_DATE] [--new_model NEW_MODEL] [--same_data SAME_DATA] {dashboard,gatherdata,downloaddata,uploaddata,modelsearch,train,forecast}

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

positional arguments:
  {dashboard,gatherdata,downloaddata,uploaddata,modelsearch,train,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. 'downloaddata` download model training and forecast
                        data from HF Hub to local data storage. 'uploaddata` upload to HF Hub any interim changes to local train and forecast data. `modelsearch` to find and save optimal hyperparameters for model training. `train` for
                        continuous model training. `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.
  --new_model NEW_MODEL
                        Optional argument for the `train` task. Whether to train a newly created model or continue training an existing pre-trained model.
  --same_data SAME_DATA
                        Optional argument for the `dashboard` task. Whether to reuse previously created search database (faster start time) or update with new forecast data (slower start time).

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "canswim",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "stock market, analytics",
    "author": "Ivelin Ivanov",
    "author_email": "ivelin117@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/01/41/9f12be6ae5fcb6f14f5174754eb2d5a7ac9dffb4284323e3686c197c606f/canswim-0.0.20250106.tar.gz",
    "platform": null,
    "description": "# canswim\nDeveloper toolkit for CANSLIM investment style practitioners\n\nFor a brief introduction read [this blog post](https://medium.com/@ivelin.atanasoff.ivanov/canswim-a-deep-learning-tool-for-canslim-practitioners-2c9740bb0d3d).\n\n[Here is also a video recording](https://www.youtube.com/watch?v=GfC-H0uxXvk&ab_channel=AustinPythonMeetup) of a CANSWIM presentation for the [Python Austin Meetup](https://www.meetup.com/austinpython/).\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] [--forecast_start_date FORECAST_START_DATE] [--new_model NEW_MODEL] [--same_data SAME_DATA] {dashboard,gatherdata,downloaddata,uploaddata,modelsearch,train,forecast}\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,downloaddata,uploaddata,modelsearch,train,forecast}\n                        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. 'downloaddata` download model training and forecast\n                        data from HF Hub to local data storage. 'uploaddata` upload to HF Hub any interim changes to local train and forecast data. `modelsearch` to find and save optimal hyperparameters for model training. `train` for\n                        continuous model training. `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  --new_model NEW_MODEL\n                        Optional argument for the `train` task. Whether to train a newly created model or continue training an existing pre-trained model.\n  --same_data SAME_DATA\n                        Optional argument for the `dashboard` task. Whether to reuse previously created search database (faster start time) or update with new forecast data (slower start time).\n\nNOTE: NOT FINANCIAL OR INVESTMENT ADVICE. USE AT YOUR OWN RISK.\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "\"Developer toolkit for CANSLIM investment style practitioners\"",
    "version": "0.0.20250106",
    "project_urls": null,
    "split_keywords": [
        "stock market",
        " analytics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "83aacc7f7f9e345ec75a734f4b0226f44207d3be60c772ab4ac29ec9532b2ac4",
                "md5": "6425fb8d4d83a0339c83d83ba5f18e5e",
                "sha256": "c16320c479808a9a50a2e4e84acaf321bbcde0a89cc3ca898d87b8b62e79bd48"
            },
            "downloads": -1,
            "filename": "canswim-0.0.20250106-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6425fb8d4d83a0339c83d83ba5f18e5e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 55563,
            "upload_time": "2025-01-05T18:34:01",
            "upload_time_iso_8601": "2025-01-05T18:34:01.212155Z",
            "url": "https://files.pythonhosted.org/packages/83/aa/cc7f7f9e345ec75a734f4b0226f44207d3be60c772ab4ac29ec9532b2ac4/canswim-0.0.20250106-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "01419f12be6ae5fcb6f14f5174754eb2d5a7ac9dffb4284323e3686c197c606f",
                "md5": "12ccef307572f02f54505518aadce921",
                "sha256": "bd63189a7c33fa1f1e9aa2fc006913d8a600bdc064b8f68c54dfa5d283879f30"
            },
            "downloads": -1,
            "filename": "canswim-0.0.20250106.tar.gz",
            "has_sig": false,
            "md5_digest": "12ccef307572f02f54505518aadce921",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 52257,
            "upload_time": "2025-01-05T18:34:03",
            "upload_time_iso_8601": "2025-01-05T18:34:03.665360Z",
            "url": "https://files.pythonhosted.org/packages/01/41/9f12be6ae5fcb6f14f5174754eb2d5a7ac9dffb4284323e3686c197c606f/canswim-0.0.20250106.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-05 18:34:03",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "canswim"
}
        
Elapsed time: 0.37774s