Sec Edgar Versions Save

Adding functions to easily access the SEC's new REST API! You can read more about the API from the SEC here. The documentation for secedgar on the new rest.py module is here.

Bringing v0.4.0 out of alpha

Fixes #269

What's Changed

• DOC: Add documentation for NetworkClient by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/230
• TEST: Add test to check user path expanded by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/246
• Fix multiple filing type matches by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/248
• ENH: Add NSAR filing types by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/250
• Process form 4 by @darrion in https://github.com/sec-edgar/sec-edgar/pull/254
• Fix-cik-map by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/256
• FIX: Fix caching issue and simplify combo code by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/249
• Fix-url-count by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/251
• TEST: Add Smoke Tests by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/258
• Gh-269 by @jackmoody11 in https://github.com/sec-edgar/sec-edgar/pull/270

New Contributors

• @darrion made their first contribution in https://github.com/sec-edgar/sec-edgar/pull/254

Full Changelog: https://github.com/sec-edgar/sec-edgar/compare/v0.4.0-alpha.2...v0.4.0-alpha.3

• Fix issue where daily CLI command would not work due to date_cleanup returning datetime.datetime instead of datetime.date

• Fixes user agent issues. All filings classes and functions require user_agent argument or a NetworkClient object with user_agent set.

Many breaking changes, as this update does a lot of restructuring.

• Rename filings.py to company.py (and respective Filings class to CompanyFilings).
• Rename master.py to quarterly.py (and respective MasterFilings class to QuarterlyFilings).
• Rename filings subdirectory to core to avoid confusion.
• Create ComboFilings class that wraps around QuarterlyFilings, DailyFilings given 2 dates.
• Create filings factory that returns the correct class based on user inputs. Returns one of ComboFilings, QuarterlyFilings, DailyFilings, CompanyFilings.
• Add many more types to FilingType enum. Switch to csv table for details.
• If no filings found for DailyFilings or MasterFilings after finding that other filings that do not match the criteria exist, then raise a NoFilingsError instead of a ValueError.

• Add user_agent argument to NetworkClient
• Bypasses CIK lookup calls to SEC if the provided argument is already a CIK.

• Gets rid of unnecessary AbstractClient.
• Flattens directory structure. The exceptions, cik_lookup, and utils have been moved to the main package directory.
• Removes cik_map module in favor of single cik_lookup module which now houses get_cik_map.
• Slightly changes functionality of get_cik_map to return single dictionary.
• Rename internal _get_cik to _get_cik_from_html.

• Fixes bug where get_response does not break after validating response (thanks to abbadata!)
• Fixes bug where get_response sleeps even after success
• Remove pause from NetworkClient initialization in favor of optional backoff_factor that relies on urllib3 retry module.