Package: lumibot
Lumibot - Algorithmic Trading LibraryBacktesting and trading for stocks, options, crypto, futures and more!Documentation - 👇 Start Here 👇To get started with Lumibot, you can check out our documentation below.Check out the documentation for the project here: 👉http://lumibot.lumiwealth.com/👈ContributorsIf you want to contribute to Lumibot, you can check how to get started below. We are always looking for contributors to help us out!Steps to contribute:Clone the repository to your local machineCreate a new branch for your featureRunpip install -r requirements_dev.txtto install the developer dependenciesInstall all the requriements from setup.py:pip install -e .Make your changesRunpytestto make sure all the tests passCreate a pull request to merge your branch into masterRunning TestsWe use pytest for our testing framework. To run the tests, you can run the following command:pytestShowing Code CoverageTo show code coverage, you can run the following command:coveragerun;coveragereport;coveragehtmlAdding an Alias on Linux or MacOSThis will show you the code coverage in the terminal and also create a folder called "htmlcov" which will have a file called "index.html". You can open this file in your browser to see the code coverage in a more readable format.If you don't want to keep typing out the command, you can add it as an alias in bash. To do this, you can run the following command:aliascover='coverage run; coverage report; coverage html'This will now allow you to run the command by just typing "cover" in the terminal.coverIf you want to also add it to your .bashrc file. You can do this by running the following command:echo"alias cover='coverage run; coverage report; coverage html'">>~/.bashrcAdding an Alias on WindowsIf you are on Windows, you can add an alias by running the following command:Add to your PowerShell Profile: (profile.ps1)functioncover{coverageruncoveragereportcoveragehtml}Setting Up PyTest in VS CodeTo set up in VS Code for debugging, you can add the following to your launch.json file under "configurations". This will allow you to go into "Run and Debug" and run the tests from there, with breakpoints and everything.NOTE: You may need to change args to the path of your tests folder.{"name":"Python: Pytest","type":"python","request":"launch","module":"pytest","args":["lumibot/tests"],"console":"integratedTerminal",}Here's an example of an actual launch.json file:{"version":"0.2.0","configurations":[{"name":"Python: Pytest","type":"python","request":"launch","module":"pytest","args":["lumibot/tests"],"console":"integratedTerminal",}]}CommunityIf you want to learn more about Lumibot or Algorithmic Trading then you will love out communities! You can join us on Discord.Join us on Discord:https://discord.gg/TmMsJCKY3TCoursesIf you need extra help building your algorithm, we have courses to help you out.For our Algorithmic Trading course:https://lumiwealth.com/algorithmic-trading-landing-pageFor our Machine Learning for Trading course:https://www.lumiwealth.com/product-category/machine-learning-purchase/For our Options Trading course:https://www.lumiwealth.com/product-category/options-trading-purchase/LicenseThis library is covered by the MIT license for open sourced software which can be found here:https://github.com/Lumiwealth/lumibot/blob/master/LICENSE