Sec-edgar-downloader

New

- Added official support for Python 3.12.

Fixed

- Fixed a bug that prevented filing types ending in `A` (e.g. DEF 14A, 2-A, N-54A) from downloading.

Fixed

- Fixed download errors for CIKs containing trailing zeros.

New

- Full package re-write to harness the SEC's new, official [Edgar API](https://www.sec.gov/edgar/sec-api-documentation).
- Added Formal rate-limiting integration using [pyrate-limiter](https://pypi.org/project/pyrate-limiter/) to reduce the chances of surpassing the SEC's 10 requests per second fair access policy.
- The underlying rate-limiter will apply a delay to all requests that surpass the 10 requests per second rate for a maximum delay of 60 seconds before raising an exception.
- Added support for declaring a company name and email to comply with the SEC's fair access guidelines for declaring a user-agent of the form: `Sample Company Name AdminContact<sample company domain>.com`.
- More info on this policy can be found [here](https://www.sec.gov/os/webmaster-faq#developers)

Changed

- Dropped support for Python 3.6 and 3.7 as they have reached end-of-life. This package now supports Python 3.8+.

- Add official support for Python 3.10.
- Pass `Accept-Encoding: gzip, deflate` and `Host: www.sec.gov` headers into all requests as recommended by the SEC fair access rules: https://www.sec.gov/os/accessing-edgar-data. This should lead to smaller request sizes as all requests are now gzipped. It should also help with 403 Forbidden errors since the package is now conforming with the entire suite of fair access rules.

New

- CIKs are now automatically zero-padded to 10 digits to ensure that filings are accurately retrieved by the SEC Edgar system. For example, passing either `"0000789019"` or `"789019"` (the CIK for MSFT) to `get()` will yield equivalent results:

python
>>> dl.get("10-K", "0000789019", amount=1)
1
>>> dl.get("10-K", "789019", amount=1)
1


Fixed

- Updated the `User-Agent` header to comply with new [SEC Edgar Fair Access requirements](https://www.sec.gov/os/accessing-edgar-data). This should resolve the 403 network errors some users are encountering when downloading a significant number of filings.

Changed
- A `ValueError` is now raised when a CIK of length >10 or a blank ticker/CIK is passed to `get()`.

Fixed

- Anchor links inside of filings are now resolved correctly. Fragments and external links should now function as intended.
- Renamed `requirements.txt` to `requirements-dev.txt` in order to prevent confusion with the dependencies listed in `setup.py`.