Skip to main content

SECStreamPy is a Python package that simplifies extracting and displaying SEC filing data.

Project description

SECStreamPy Library


Python Versions Latest Release

Introduction

SECStreamPy is a powerful and user-friendly Python package designed to enhance data analysis. It simplifies the extraction and presentation of information for various forms from the SEC website, offering enriched data display for SEC form types, filing details, and financial statements, making it an essential tool for professionals working with regulatory filings.

Features

  • 📁 Access any SEC filing: You can access any filings on SEC forms of Form 8-K and Form 10-K etc.
  • 📅 List filings for any date range: List filings by date e.g. or date range 2024-02-29:2024-03-15
  • 🌟 User Friendly library: Uses rich & tabulate library to display SEC Edgar data in a beautiful way.
  • 🏗️ Filter filings data: Build data filtering by cik, accession number, form type, filing date
  • 🔍 Preview the text data for a filing: You can preview the filing (sections) in the terminal or a notebook.
  • 📊 Parse to Dataframe: You can parse filings to a dataframe.
  • 📈 Financial Statement: Get financial statements of Form 8-K and Form 10-K of various companies.

Get Started on Windows/MacOS/Linux Terminal


You can use Poetry or any dependency manager or use the general pip install command to install SECStreamPy. Before you install SECStreamPy,it is best to set your environment variable SEC_IDENTITY in a .env file.

Set up SEC_IDENTITY environment variable in a .env file in your project.

SEC_IDENTITY=<your sec identity here>

You can install the latest SECStreamPy version or any version. Below is how to use the latest version of SECStreamPy or any version in your terminal.

pip install --upgrade SECStreamPy

or

pip install SECStreamPy==<latest version number here>   

Using pip command to install SECStreamPy

pip install SECStreamPy

Using Poetry to install SECStreamPy

  1. Open your terminal and install poetry [if you do not have poetry] using pip.

    pip install poetry
    

    or Install poetry using pipx.

    pipx install poetry
    

    or Install using curl

    curl -sSL https://install.python-poetry.org | python3 -
    
  2. Create a project using poetry command. This will create a pyproject.TOML in your project. Follow the instructions to finish creating your project

    poetry new project_name
    
  3. Change directory to your project

    cd project_name
    
  4. Run the poetry command to add SECStreamPy:

    poetry add SECStreamPy
    

Use SECStreamPy with Jupyter


  1. Open notebook in your project and install SECStreamPy using pip command.

    pip install SECStreamPy
    

Do you have any issue or want to contribute to SECStreamPy library?

If you have any issue or contribution, please write an issue with this link: https://github.com/DataDock-AI/SECStreamPy/issues

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

secstreampy-2.2.0.tar.gz (60.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

secstreampy-2.2.0-py3-none-any.whl (77.1 kB view details)

Uploaded Python 3

File details

Details for the file secstreampy-2.2.0.tar.gz.

File metadata

  • Download URL: secstreampy-2.2.0.tar.gz
  • Upload date:
  • Size: 60.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for secstreampy-2.2.0.tar.gz
Algorithm Hash digest
SHA256 67ed953baade972cea963f0cc66feb1e161db7456c47ee0a34ad3ef6254b3138
MD5 81fa45c8328887d8d807ef7782efbf43
BLAKE2b-256 f48931c5617ac34b1e42178de1b9cfb333a479a162f654607a6e687773bfa588

See more details on using hashes here.

File details

Details for the file secstreampy-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: secstreampy-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 77.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for secstreampy-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0973260cdb3ff951dc7066cdc0cea90060d955b7dbf5fdddb680d97378b227d
MD5 cec78024ca1464108f588d24eebeda24
BLAKE2b-256 8689f788e8fb68a0469ca79e5680805bf862826493cc75c22091d879d3c1023d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page