Installation

Using pip

You can install edgar-sec using pip:

pip install edgar-sec

Using conda

edgar-sec is available on Conda-Forge. You can install it with:

conda install -c conda-forge edgar-sec

We recommend creating a dedicated environment for your project:

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

Optional Type Stubs

If you need type stubs for development (e.g., for cachetools), you can install the optional dependencies:

Using pip:

pip install edgar-sec[types]

Development Installation

For development purposes, you can install the package with all development dependencies:

Using Poetry (recommended):

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

Using pip:

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

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows, use venv\Scripts\activate

# Install in development mode with dev dependencies
pip install -e ".[dev,types]"

# Install pre-commit hooks
pre-commit install

Requirements

edgar-sec has the following dependencies:

• Python 3.9 or newer

• httpx - For HTTP requests

• tenacity - For retry logic

• cachetools - For caching API responses

All dependencies are automatically installed when using pip or conda.