ndxtest 0.0.2

ndxtest lets you test trading strategies on the S&P 500.

lets you test trading strategies on the S&P 500.

pip install ndxtest

Explore the documentation

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

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.

(back to top)

Built With

(back to top)

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 and fpdf

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.

(back to top)

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).

(back to top)

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!

1. Fork the Project
2. Create your Feature Branch: git checkout -b feature/AmazingFeature
3. Commit your Changes: git commit -m 'Add some AmazingFeature'
4. Push to the Branch: git push origin feature/AmazingFeature
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

lksdnx - [e-mail]

Project Link: https://github.com/lksdnx/ndxtest

(back to top)

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!

(back to top)