formai-sdnauditor 0.1.1
AI software for SEC form processing - SDN / auditor check
Requires Python: >=3.7
Keywords: text mining,natural language processing

# formai_sdnauditor

This is the codebase for AI based SEC form processing - SDN / Auditor check

[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)

## Install

### Windows

```powershell
pip install -U git+ssh://git@github.com/hmjohnyu/formai_sdnauditor.git
```


### Ubuntu

```bash
pip install -U git+ssh://git@github.com/hmjohnyu/formai_sdnauditor.git
```

### MacOS

```zsh
pip install -U git+ssh://git@github.com/hmjohnyu/formai_sdnauditor.git
```


### MacOS

```zsh

```

## Usage

Run auditor check with CIKs
```bash
  checkauditor  output --cik '1738906,1821468,1741530,1779476,1177167' --forms '20-f' --date '2021-01-01, 2022-12-31' --overwrite  
```

Run check certifications with CIKs in a file
```bash
	checkauditor  output --cik_file './test/testdata/ciks.csv' --overwrite
```

Get help for the `checkauditor` command.

```bash
  checkauditor --help
```

```
Usage: checkauditor [OPTIONS] OUTDIR

  Console script for extract auditor firm name from filing and check against PCAOB registered auditing firm list

Options:
  --cik TEXT       A single CIK or comma separated CIK list
  --cik_file TEXT  csv or tsv file of CIK list with the header that contains
                   'CIK'

  --forms TEXT     A single form type or comma separated form list
  --date TEXT      Starting and ending date, comma separated
  --overwrite      Overwrite the existing output
  --help           Show this message and exit.
  ```

Lookup auditor in input_file against auditor firm list in pcaob_file and save result to output_file
```bash
  auditorlookup './tests/testdata/audit_firm_testing_21_22.csv' --pcaob_file './tests/testdata/pcaob_list.csv' --output_file './tests/testdata/audit_firm_testing_21_22_result.csv'
```

Get help for the `auditorlookup` command.

```bash
  auditorlookup --help
```

```
Usage: auditorlookup [OPTIONS] input_file

  Console script for lookup given auditor firm name against PCAOB registered auditing firm list

Options:
  --pcaob_file     PCAOB file that contains the auditor firm list to check against. If left out, default list will be used ('./tests/testdata/pcaob_list.csv')
  --output_file    output file name to save the result. If left out, result will be saved to input_file
  --help           Show this message and exit.
  ```


Lookup suspect against SDN / Non-SDN list
```bash
  sdnlookup './tests/testdata/sd_to_check.csv'  --output_file './tests/testdata/sd_check_result.csv'
```

Get help for the `sdnlookup` command.

```bash
  sdnlookup --help
```

```
Usage: sdnlookup [OPTIONS] input_file

  Console script for lookup suspect name in input_file against SDN / Non-SDN list
    SDN list https://www.treasury.gov/ofac/downloads/sdn.del 
    Non-SDN list https://www.treasury.gov/ofac/downloads/consolidated/cons_prim.del

Options:
  --input_file     input file contains the suspects to check against
  --output_file    output file name to save the result
  --help           Show this message and exit.
  ```