Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for passing of sub document to get one part of a filing #5

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

nickderobertis
Copy link

@nickderobertis nickderobertis commented Aug 18, 2019

Thanks for putting together this EDGAR tool.

I needed to get just one exhibit from the 10-K, so I added this functionality into the getDocuments function, but using a keyword argument so that the original usage of the function is unchanged.

I tried to set up the xpath generally so that it will work for any exhibit/sub-document type, you just need to pass the name of it and it will do a string match on the Type column.

Usage would be like this:

edgar.getDocuments(tree, sub_document='EX-21.01', noOfDocuments=5)

I hope you'll include this in the main module, I think it could be very useful to others.

Nick DeRobertis added 3 commits August 18, 2019 13:33
Use Filing class in internals and as another interface which can be used to get metadata for the filings
@nickderobertis
Copy link
Author

I ended up also needing to get some metadata for the filings - e.g. period of report. I created a Filing class to manage getting this metadata as well as the original logic to get documents and sub documents. I also created a new function, getFilings, which returns Filing instances so that further actions can be taken on them by the user (track metadata and download document). The original getDocuments function still has the same behavior.

If you want to merge just a portion of these changes, let me know and I can split them up.

@joeyism
Copy link
Owner

joeyism commented Jan 4, 2020

There seems to be a conflict for this. If you can resolve it, I'll merge this in. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants