A tool for analyzing complex company financial documents from the comfort of your own computer.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
scripts
tests
.gitignore
.travis.yml
LICENSE.md
README.rst
download_edgar.py
edgar_tickers.txt
get_ticker_list.py
ingestor.py
requirements.txt
searcher.py
sedar_tickers.txt
setup.cfg
setup.py
threadedSearch.py

README.rst

PyPI version Travis-CI

DIY-FilingsResearch is a library for analyzing complex company financial documents from the comfort of your own computer.

Installation

The easiest way to install DIY-FilingsResearch is with pip

sudo pip install DIY-FilingsResearch

Made sure your sys.path is correct. Note it is currently just a collection of scripts.

Requirements

  • Python >= 2.7 or >= 3.3

DIY-FilingsResearch relies on PyLucene. For installation directions see the wiki.

Initialization

To start using the library, first import Ingestor and Edgar

from ingestor import Ingestor, Edgar

Edgar (US) and Sedar (Canada) are currently supported. Note however that the flows are a bit different. See the note at the bottom about the Sedar flow.

Simple Download Workflow

First specific what kind of files using the new Edgar basic object

ingestor = Ingestor()
edgar = Edgar("xbrl")

xbrl or html are currently supported

Then pass ingest_stock() with a stock ticker to ingest and a directory to store the downloaded docs into file_downloader()

ingestor.file_downloader(edgar.ingest_stock("AAPL"), downloaded_docs_directory)

See the wiki for a special note on Sedar parsing.

Testing

To run the unit tests, you need pytest

pip install pytest

Once you have that, cd into the root directory of this repo and

py.test --tb=line -vs

License

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the license.