/quantive

Open-source package for stock market analysis and trading

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues GPL-3.0 License


quantive

Quantive will be an open-source package for stock market analysis and trading. This package will be modular and customizable, interfacing with several major exchanges and providing analysis, execution, and logging capabilities.
Explore the docs ยป

ยท Report Bug ยท Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Quantive will be an open-source package for stock market analysis and trading. This package will be modular and customizable, interfacing with several major exchanges and providing analysis, execution, and logging capabilities.

Quantive will be built on a monitor-buy-monitor-sell-record framework.

๐Ÿšง๐Ÿšง Under construction ๐Ÿšง๐Ÿšง

(back to top)

Built With

PythonBootstrapC++

(back to top)

Getting Started

Eventually, we will make this software pip installable.

๐Ÿšง๐Ÿšง Under construction ๐Ÿšง๐Ÿšง

Prerequisites

conda activate quantive
pip install -r requirements.txt

Installation

๐Ÿšง๐Ÿšง Under construction ๐Ÿšง๐Ÿšง

Usage

For more examples, please refer to the Documentation

๐Ÿšง๐Ÿšง Under construction ๐Ÿšง๐Ÿšง

(back to top)

Roadmap

The roadmap for the software will be laid out here. Minor functionality will be grouped under major features. Once all the desired functionality for a particular feature is implemented, it will be removed, and information about the feature will be accessible in the documentation.

  • Set up documentation (documentation now running on pdoc)
  • Set up project structure
    • Finalize organization
    • Make installable
  • Pipeline
    • Make barebones pipeline that calls and incorporates all modules
      • Implement configuration choice
      • Implement API access
      • Implement monitor
      • Implement test buy
      • Implement test sell
      • Implement test record
    • Configuration
      • Decide on configuration method (how to change pipeline settings?)
  • Monitor
    • Construct simple proof-of-concept exchange module
      • Add connection to API/buy/sell/account functionality
      • Test
    • Construct barebones monitoring framework using yfinance
    • Construct simulated ticker prices for testing
  • Buy
    • Construct simple proof-of-concept module
  • Sell
    • Construct simple proof-of-concept module
  • Record
    • Construct simple proof-of-concept module
    • Test HTML interfaces
  • Analysis
    • Develop core list of functions to impelement

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks :)

  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 GPLv3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Joseph Farah - jfarah@lco.global - jrfarah.com

Project Link: https://github.com/jrfarah/quantive

(back to top)

Acknowledgments

๐Ÿšง๐Ÿšง Under construction ๐Ÿšง๐Ÿšง

(back to top)