ndxtest lets you test trading strategies on the S&P 500.
Project description
lets you test trading strategies on the S&P 500.
pip install ndxtest
Explore the documentation
Report Bug
·
Request Feature
Table of Contents
About The Project
ndxtest
is a package for Python developed by lksdnx
. It lets you test trading ideas
and perform backtests on the S&P 500. The daily price data for S&P 500 companies is available in the
repository.
Developing, documenting, testing and releasing ndxtest
was and is primarily an educational project.
Use it at your own risk and read the disclaimer
on the documentation page.
Built With
Getting Started
For detailed information on how to install and use ndxtest
please refer to the
User Manual on the documentation page.
Prerequisites
- Install Python 3.9 or higher.
- Install an IDE of your choice to work with.
- Install git to easily download the required data directory from the repository.
- Allow both Python and git to be added to the
Path
during their respective installations.
Installation
In the terminal do:
pip install ndxtest
This will install ndxtest
as well as its python package dependencies:
numpy
,pandas
,matplotlib
,yfinance
andfpdf
Then in the terminal do:
git clone --depth 1 --filter=blob:none --sparse https://github.com/lksdnx/ndxtest
cd ndxtest
git sparse-checkout set data
You can delete the .git folder afterwards. Keep the data
folder.
Usage
For instructions on how to work with this package, please refer to the Documentation.
Roadmap
See here about new features of upcoming releases of ndxtest
See the open issues for a list of proposed features (and known issues).
Contributing
Any contributions are greatly appreciated.
If you have an idea that would make ndxtest
better, please fork the repo and create a pull request.
You can also simply open an issue .
Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch:
git checkout -b feature/AmazingFeature
- Commit your Changes:
git commit -m 'Add some AmazingFeature'
- Push to the Branch:
git push origin feature/AmazingFeature
- Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
lksdnx - lukas.dnx@gmail.com
Project Link: https://github.com/lksdnx/ndxtest
Acknowledgments
I express my gratitude to all the people who contributed to build the FreeCodeCamp. You have created an amazing online resource. Furthermore I would like to thank all the content creators on YouTube for producing excellent educative material on coding. Keep up the great work!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.