Metadata-Version: 2.1
Name: unusualvolume
Version: 0.1.2
Summary: Monitor stock market transactions for unusual volume and (possibly) make millions
Home-page: https://github.com/mfdeux/unusualvolume
License: MIT
Author: Marc Ford
Author-email: mrfxyz567@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: joblib (>=0.16.0,<0.17.0)
Requires-Dist: numpy (>=1.19.1,<2.0.0)
Requires-Dist: pandas (>=1.1.0,<2.0.0)
Requires-Dist: python-dateutil (>=2.8.1,<3.0.0)
Requires-Dist: requests (>=2.24.0,<3.0.0)
Requires-Dist: tqdm (>=4.48.2,<5.0.0)
Requires-Dist: yfinance (>=0.1.54,<0.2.0)
Project-URL: Repository, https://github.com/mfdeux/unusualvolume
Description-Content-Type: text/markdown

# unusualvolume

Monitor stock market transactions for unusual volume and (possibly) make millions.

## Demo

![](unusualvolume_demo.gif)

## About

A simple command line tool to retrieve stock market data (US-only) and analyze trading volumes for anomalies.

## Use Cases

1. Mining valuable trading information and getting ahead of possible large changes in stock prices
2. Transaction monitoring for OSINT (open source intelligence) purposes
3. Collecting data to train your own ML model


## Installation

```shell script
$ pip install unusualvolume --upgrade
```

## Usage

```shell script
$ unusualvolume scan
```
