Skip to content

Commit

Permalink
Added CHANGELOG for v2.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
jadchaar committed Dec 26, 2021
1 parent 21160e0 commit f0fa147
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Changelog

## 2.0.0 - 12/25/21

### New

- Full revamp of API. Renamed `CIKMapper` to `StockMapper` and added support for mutual fund mapping capabilities via the `MutualFundMapper`. The `MutualFundMapper` is capable of obtaining mappings between CIKs, tickers, series IDs, and class IDs. The `StockMapper` is capable of obtaining mappings between CIKs, tickers, company names, and exchanges.
- Replaced function calls on mapper objects with properties.
- Added support for creating mappings to and from exchanges via the `StockMapper`.
- Added full support for PEP 484-style type hints.
- Added `raw_dataframe` property to both mappers that exposes the underlying pandas dataframe for additional extensibility.
- Added [examples to GitHub repository](https://github.com/jadchaar/sec-cik-mapper/tree/main/examples) to improve first-time usage.
- Updated naming of JSON and CSV mappings and added support for a number of new mappings in `auto_generated_mappings`.
- Improved documentation in README on how to download the auto-generated mappings via curl from GitHub or jsDelivr.

### Internal

- Improved abstractions to reduce code duplication across both mapper classes.
- Migrated PyPI publishing system to [Flit](https://flit.readthedocs.io/).
- Revamped README and documentation. The latest documentation can be found [here](https://sec-cik-mapper.readthedocs.io).
- Full rewrite of tests to support new properties and package APIs.

## 1.0.0 - 12/15/21

- Initial release.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ build-dist:

upload-dist:
. venv/bin/activate; \
flit publish
flit publish --setup-py

publish: test clean build-dist upload-dist clean
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Features
- Generate up-to-date mappings from the SEC as native Python dictionaries
- Mappings for both stocks and mutual funds
- Mapping data exposed as a raw pandas dataframe for custom data processing and usage
- Support for Python 3.6+
- Full support for PEP 484-style type hints and the `mypy type checker <https://mypy.readthedocs.io/en/stable/>`_
- `Auto-generated mappings <https://github.com/jadchaar/sec-cik-mapper/tree/main/auto_generated_mappings>`_, updated daily, available from GitHub for use outside of Python
- Support for Python 3.6+

Supported Mappings Identifiers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit f0fa147

Please sign in to comment.