You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Daniel Beadle c0d6ef4575 Update 'README.md' 11 months ago
.DS_Store Initial commit 1 year ago
.gitignore Initial commit 1 year ago
README.md Update 'README.md' 11 months ago
parser.py Updated tests and documentation 11 months ago
pytest.ini Initial commit 1 year ago
requirements.txt Updated tests and documentation 11 months ago
test.py Updated tests and documentation 11 months ago

README.md

Plaid Coding Exercise

Requirements:

    - Python3.6 or greater
    - Pip3

Setup and Usage Instructions

Unix-Like System

  1. Clone the repository

  2. Create a virtual environment for this project

    Install virtualenv, if you don't already have it:

         ```bash
         pip3 install virtualenv
         ```
    

    Create the virtual environment

         ```bash
         virtualenv venv -p python3
         ```
    
  3. Activate the virtual environment

     ```bash
     source venv/bin/activate
     ```
    
  4. Install the required Python packages with

     ```bash
     pip3 install -r requirements.txt
     ```
    
  5. Run it!

     ```bash
     python3 parser.py --cik 0001555283
     ```
    

Runing Unit Tests

  1. Navigate to the project directory

  2. Activate your virtual environment using the instructions detailed in the install instructions

  3. Run the tests

Future Steps

  • More coverage of individual methods in unit tests
  • Implement method to retrieve past filings from a specific date
  • Unit tests for the file output