TradeTide


NameTradeTide JSON
Version 0.1.5 PyPI version JSON
download
home_pageNone
SummaryA package for stocks market backtesting.
upload_time2024-12-10 17:35:49
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2020 Martin de Sivry Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords backtesting stocks market
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |Logo|

|python|
|docs|
|PyPi|
|PyPi_download|

TradeTide
=========

TradeTide is a trading platform designed to empower traders with advanced analytics, real-time market data, and automated trading capabilities. Our platform caters to both novice and experienced traders, offering a wide range of tools to analyze market trends, execute trades, and manage portfolios efficiently.


Testing
*******

To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as

.. code:: python

   >>> git clone https://github.com/MartinPdeS/TradeTide.git
   >>> cd TradeTide
   >>> pip install -r requirements/requirements.txt
   >>> pytest

----


Coding example
**************

.. code-block:: python

   from TradeTide import BackTester, indicators, get_market_data
   from TradeTide import capital_managment, risk_management

   market_data = get_market_data('eur', 'usd', year=2023, time_span='30day', spread=0)

   indicator = indicators.BB(periods=20)

   indicator.generate_signal(market_data)

   indicator.plot()

   backtester = BackTester(market=market_data, strategy=indicator)

   risk = risk_management.DirectLossProfit(
       market=market_data,
       stop_loss='10pip',
       take_profit='10pip',
   )

   capital_managment = capital_managment.LimitedCapital(
       initial_capital=100_000,
       risk_management=risk,
       max_cap_per_trade=10_000,
       limit_of_positions=1,
       micro_lot=1_000
   )

   backtester.backtest(capital_managment=capital_managment)


   backtester.plot(show_price=True)

   metrics = backtester.metrics

   metrics.print()


|example_image|

----


Contact Information
************************
As of 2024, the project is still under development. If you want to collaborate, it would be a pleasure! I encourage you to contact me.

PyMieSim was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_  .

Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=TradeTide>`_ .


.. |python| image:: https://img.shields.io/pypi/pyversions/pymiesim.svg
   :target: https://www.python.org/

.. |Logo| image:: https://github.com/MartinPdeS/TradeTide/raw/master/docs/images/logo.png

.. |example_image| image:: https://github.com/MartinPdeS/TradeTide/raw/master/docs/images/image_example.png

.. |docs| image:: https://github.com/martinpdes/tradetide/actions/workflows/deploy_documentation.yml/badge.svg
   :target: https://martinpdes.github.io/TradeTide/
   :alt: Documentation Status

.. |PyPi| image:: https://badge.fury.io/py/TradeTide.svg
    :target: https://badge.fury.io/py/TradeTide

.. |PyPi_download| image:: https://img.shields.io/pypi/dm/TradeTide.svg
    :target: https://pypistats.org/packages/tradetide

.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/TradeTide/python-coverage-comment-action-data/badge.svg
   :alt: Unittest coverage
   :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/TradeTide/blob/python-coverage-comment-action-data/htmlcov/index.html

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "TradeTide",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "backtesting, stocks, market",
    "author": null,
    "author_email": "Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/a5/12/a5a2e54c8e7c48938d1d3c02eb2e93668289d83ea66e4e7627861e0418f1/tradetide-0.1.5.tar.gz",
    "platform": null,
    "description": "|Logo|\n\n|python|\n|docs|\n|PyPi|\n|PyPi_download|\n\nTradeTide\n=========\n\nTradeTide is a trading platform designed to empower traders with advanced analytics, real-time market data, and automated trading capabilities. Our platform caters to both novice and experienced traders, offering a wide range of tools to analyze market trends, execute trades, and manage portfolios efficiently.\n\n\nTesting\n*******\n\nTo test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as\n\n.. code:: python\n\n   >>> git clone https://github.com/MartinPdeS/TradeTide.git\n   >>> cd TradeTide\n   >>> pip install -r requirements/requirements.txt\n   >>> pytest\n\n----\n\n\nCoding example\n**************\n\n.. code-block:: python\n\n   from TradeTide import BackTester, indicators, get_market_data\n   from TradeTide import capital_managment, risk_management\n\n   market_data = get_market_data('eur', 'usd', year=2023, time_span='30day', spread=0)\n\n   indicator = indicators.BB(periods=20)\n\n   indicator.generate_signal(market_data)\n\n   indicator.plot()\n\n   backtester = BackTester(market=market_data, strategy=indicator)\n\n   risk = risk_management.DirectLossProfit(\n       market=market_data,\n       stop_loss='10pip',\n       take_profit='10pip',\n   )\n\n   capital_managment = capital_managment.LimitedCapital(\n       initial_capital=100_000,\n       risk_management=risk,\n       max_cap_per_trade=10_000,\n       limit_of_positions=1,\n       micro_lot=1_000\n   )\n\n   backtester.backtest(capital_managment=capital_managment)\n\n\n   backtester.plot(show_price=True)\n\n   metrics = backtester.metrics\n\n   metrics.print()\n\n\n|example_image|\n\n----\n\n\nContact Information\n************************\nAs of 2024, the project is still under development. If you want to collaborate, it would be a pleasure! I encourage you to contact me.\n\nPyMieSim was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdS>`_  .\n\nEmail:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=TradeTide>`_ .\n\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/pymiesim.svg\n   :target: https://www.python.org/\n\n.. |Logo| image:: https://github.com/MartinPdeS/TradeTide/raw/master/docs/images/logo.png\n\n.. |example_image| image:: https://github.com/MartinPdeS/TradeTide/raw/master/docs/images/image_example.png\n\n.. |docs| image:: https://github.com/martinpdes/tradetide/actions/workflows/deploy_documentation.yml/badge.svg\n   :target: https://martinpdes.github.io/TradeTide/\n   :alt: Documentation Status\n\n.. |PyPi| image:: https://badge.fury.io/py/TradeTide.svg\n    :target: https://badge.fury.io/py/TradeTide\n\n.. |PyPi_download| image:: https://img.shields.io/pypi/dm/TradeTide.svg\n    :target: https://pypistats.org/packages/tradetide\n\n.. |coverage| image:: https://raw.githubusercontent.com/MartinPdeS/TradeTide/python-coverage-comment-action-data/badge.svg\n   :alt: Unittest coverage\n   :target: https://htmlpreview.github.io/?https://github.com/MartinPdeS/TradeTide/blob/python-coverage-comment-action-data/htmlcov/index.html\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2020 Martin de Sivry  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A package for stocks market backtesting.",
    "version": "0.1.5",
    "project_urls": null,
    "split_keywords": [
        "backtesting",
        " stocks",
        " market"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "91ddd34d54f58f10cef2b4dc57ab8491c95909330d27a62f51a5e3fee4a5a7c0",
                "md5": "2e94e2dc807345dc4425212b508b0ab8",
                "sha256": "9efcb791ce115751c7a42b0256c0c816a03e83391563efdd49ee9b3e85a331cc"
            },
            "downloads": -1,
            "filename": "TradeTide-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2e94e2dc807345dc4425212b508b0ab8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10647334,
            "upload_time": "2024-12-10T17:35:45",
            "upload_time_iso_8601": "2024-12-10T17:35:45.955798Z",
            "url": "https://files.pythonhosted.org/packages/91/dd/d34d54f58f10cef2b4dc57ab8491c95909330d27a62f51a5e3fee4a5a7c0/TradeTide-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a512a5a2e54c8e7c48938d1d3c02eb2e93668289d83ea66e4e7627861e0418f1",
                "md5": "89bb099c427b97d7907c43ffaf52dba0",
                "sha256": "d6f752b63bfb08826c4ed57629b343b2915e366954675311678c1a55f8cbea28"
            },
            "downloads": -1,
            "filename": "tradetide-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "89bb099c427b97d7907c43ffaf52dba0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 10332555,
            "upload_time": "2024-12-10T17:35:49",
            "upload_time_iso_8601": "2024-12-10T17:35:49.865355Z",
            "url": "https://files.pythonhosted.org/packages/a5/12/a5a2e54c8e7c48938d1d3c02eb2e93668289d83ea66e4e7627861e0418f1/tradetide-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-10 17:35:49",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "tradetide"
}
        
Elapsed time: 0.37877s