Installing Edgar-SEC#

Edgar-SEC is available on both PyPI and Conda-Forge. This page covers multiple ways to install Edgar-SEC for production or development use.

—

Installation Methods#

Install the latest stable release from PyPI:

pip install edgar-sec

Installs core dependencies needed for working with the EDGAR API.

Install via Conda-Forge:

conda install -c conda-forge edgar-sec

We recommend creating a new environment:

conda create -n myenv
conda activate myenv
conda install -c conda-forge edgar-sec

Clone and install for local development:

git clone https://github.com/nikhilxsunder/edgar-sec.git
cd edgar-sec
poetry install

See Contributing to Edgar-SEC for developer guidelines.

—

Optional Enhancements#

Install Type Stubs for Static Typing

Boost development experience with type hints (e.g., mypy, pyright):

pip install edgar-sec[types]

Includes stubs for cachetools.

Install with Dev Tools

To enable dev utilities, and full lint/test support:

pip install edgar-sec[dev]

See the api-overview for testing setup.

—

Developer Quick Setup#

Development Setup (Poetry)

Clone the repository and install with all development dependencies:

git clone https://github.com/nikhilxsunder/edgar-sec.git
cd edgar-sec
poetry install
View Source on GitHub
Alternative Setup (conda + pip)

Create a dedicated environment manually:

git clone https://github.com/nikhilxsunder/edgar-sec.git
cd edgar-sec

conda create -n edgar-sec-dev python=3.10
conda activate edgar-sec-dev

pip install -e ".[dev,types]"

pre-commit install
View Source on GitHub

—