pyDocking

pyDocking is a python package that helps in detecting insider trading activities in the stock market.
Explore the docs »

View Demo · 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

Insider trading refers to the practice of buying or selling securities by individuals who possess non-public information about a company. This information may include financial results, mergers and acquisitions, or other confidential information that is not yet available to the public. The individuals who engage in insider trading are typically corporate insiders, such as company executives and board members, but it can also include anyone who possesses non-public information.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the package and how to install them.

Installation

1. Clone the repo

   git clone https://github.com/tuhinmallick/pyDocking.git

2. Go to the project directory

   cd pyDocking

3. Install environment or dependecies

   conda env create -n ENVNAME --file docs/environment.yml

   or

   pip install -r requirements.txt

4. Import the package in .py

   from insider_eda.eda_base import Exploratory_data_analysis

(back to top)

Usage

For more examples, please refer to the Notebook

(back to top)

Roadmap

• Granger casaulty test
• AD Fuller test
• Feature 3
  • Nested Feature

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

This project is licensed under the terms of the MIT license. See LICENSE for more details.

(back to top)

Authors

• @tuhinmallick

Contact

Your Name - @tuhinmallick - tuhin.mllk@gmail.com

Project Link: https://github.com/tuhinmallick/pyDocking

(back to top)

Acknowledgments

• ilyaryabov

(back to top)