Metadata-Version: 2.1
Name: insidertrading
Version: 0.0.7
Project-URL: Documentation, https://github.com/dfwcnj/insidertrading#readme
Project-URL: Issues, https://github.com/dfwcnj/insidertrading/issues
Project-URL: Source, https://github.com/dfwcnj/insidertrading
Author-email: Don Caldwell <dfwcnj@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# insidertrading

-----

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Installation

```console
pip install insidertrading
```

## License

`insidertrading` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Description

This package chooses the largest dollar transactions in the SEC form345
file and reports transactions where the stock price rose, in case of an
acquisition, or fell, in case of a disposal, over a certain percentage
dugine the following week.

THIS DOES NOT CLAIM THAT ANY OF THESE TRANSACTIONS ARE ILLEGAL.

It merely reports that the stock moved by some threshold after the
transaction. It could be because of coincidence, because the stock is
unusually volatile, or some other innocuous reason.

If you do not provide a --yq argument, the command determins the last
quarter from the current date and uses that

if you do not provide an --insiderdb argument, the sqlite3 database is
created in the current directory

## Usage

usage: edgarinsidertrading [-h] [--yq YQ] [--threshold THRESHOLD]
                           [--interval INTERVAL] [--insiderdb INSIDERDB]
                           [--directory DIRECTORY] [--file FILE]

report possibly illegal insider trading

options:
  -h, --help            show this help message and exit
  --yq YQ               year quarter in form YYYYQ[1-4]
  --threshold THRESHOLD
                        stock price change threshold - 0-50
  --interval INTERVAL   number of days to consider for price movements 1-14
  --insiderdb INSIDERDB
                        full path to the sqlite3 database - default in memory
  --directory DIRECTORY
                        directory to store the output
  --file FILE           csv file to store the output - default stdout
