Changelog

All notable changes to edgar-sec will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

2.0.1 - 2025-08-14

Fixed

• Minor bug fix

  • Added CIK validation to EdgarAPI.get_company_facts (sync)

2.0.0 - 2025-08-05

Changed

• Updated pre-commit-config.yaml

• Conda/Conda-Forge version now 2.0.0 in both meta.yaml files

• Complete overhaul of sphinx documentation

• Changed sphinx theme to pydata-sphinx-theme

• Updated pyproject.toml

• Updated imports for init.py

• edgar_sec.py renamed to clients.py

• edgar_data.py renamed to objects.py

• Markdown documents updated:

  • CHANGELOG.md

  • CONTRIBUTING.md

  • README.md

  • SECURITY.md

• update-feedstock.yml merged into main.yml

Added

• Created conda-forge directory.

  • Added meta.yaml for conda-forge.

• Added asyncache dependency

• Added favicon file: edgar-sec-favicon.ico

• Added logo file: edgar-sec-logo.png

• Added [json_ld.js(nikhilxsunder/edgar-sec)] for sphinx

• Added sphinx autosummary templates:

  • attribute.rst

  • class.rst

  • method.rst

• Added sphinx dependencies:

  • sphinxext-opengraph

  • sphinx-design

• Added robots.txt

• Added sync_about_version.py

• Added sync_conda_forge_version.py

• Added sync_conf_version.py

• Added about.py

• Added helpers.py

• Added complete test suite:

  • clients_test.py

  • objects_test.py

  • helpers_test.py

• Markdown documents added:

  • DCO.md

  • ROADMAP.md

• Added security analysis through Socket

Fixed

• Fixed dependency list in sync_conda_recipe.py

• Fixed return objects in objects.py

• Fixed caching implementations in clients.py

• Achieved OpenSSF Gold

• Achieved 100% test coverage on Codecov

Removed

• Deleted update_feedstock.py

• Deleted type stub files:

  • edgar_data.pyi

  • edgar_sec.pyi

• Deleted update-feedstock.yml

1.0.1 - 2025-03-21

Fixed

• Minor patch for publishing error (Anaconda)

1.0.0 - 2025-03-21

Added

• EdgarAPI class for interacting with SEC EDGAR API

• Full async support through EdgarAPI.Async

• Data classes for structured responses

• Built-in caching using cachetools

• Rate limiting to comply with SEC’s 10 requests/second guideline

• Type stubs (edgar_sec.pyi, edgar_data.pyi)

• Comprehensive test suite

• GitHub Actions workflows:

  • Analyze (linting, type checking)

  • CodeQL (security scanning)

  • Tests and Coverage

  • Documentation build and deploy

• Documentation: QuickStart, API Reference, Examples

• GPG signing for package releases

• Security policy and contribution guidelines

• Sphinx documentation structure

• Test coverage reporting in GitHub Actions

• Anaconda Distribution

Changed

• Updated project structure to use Poetry for dependency management

• Improved error handling for API requests

• Enhanced documentation with real-world examples

0.0.2 - 2025-02-10

Added

• Initial project structure

• Basic EdgarAPI class

• Simple configuration for API requests

• Initial README and documentation

• GitHub repository setup

• First working prototype for SEC EDGAR API interaction

[0.0.1] - 2025-02-09

Added

• Project initialization

• License file

• Basic package configuration

• Initial directory structure