{"id":18005625,"url":"https://github.com/areed1192/python-sec","last_synced_at":"2025-05-16T19:04:14.100Z","repository":{"id":43725594,"uuid":"238246162","full_name":"areed1192/python-sec","owner":"areed1192","description":"A simple python library that allows for easy access of the SEC website so that someone can parse filings, collect data, and query documents.","archived":false,"fork":false,"pushed_at":"2025-01-12T15:48:40.000Z","size":27431,"stargazers_count":125,"open_issues_count":4,"forks_count":50,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-05-15T08:46:56.487Z","etag":null,"topics":["finance","python","sec","securities-and-exchange-commission","web-scraper"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/areed1192.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["areed1192"],"patreon":"sigmacoding"}},"created_at":"2020-02-04T16:01:36.000Z","updated_at":"2025-05-13T03:24:49.000Z","dependencies_parsed_at":"2025-02-05T20:05:38.204Z","dependency_job_id":"f89dacd2-6a3f-4b6b-9d22-14f5a7de08a2","html_url":"https://github.com/areed1192/python-sec","commit_stats":{"total_commits":52,"total_committers":3,"mean_commits":"17.333333333333332","dds":"0.038461538461538436","last_synced_commit":"b21a5e606eab03e663ab4e69e077a6844a9a1a40"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areed1192%2Fpython-sec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areed1192%2Fpython-sec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areed1192%2Fpython-sec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areed1192%2Fpython-sec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/areed1192","download_url":"https://codeload.github.com/areed1192/python-sec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254592368,"owners_count":22097011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["finance","python","sec","securities-and-exchange-commission","web-scraper"],"created_at":"2024-10-30T00:20:51.390Z","updated_at":"2025-05-16T19:04:14.020Z","avatar_url":"https://github.com/areed1192.png","language":"Python","funding_links":["https://github.com/sponsors/areed1192","https://patreon.com/sigmacoding","https://www.patreon.com/sigmacoding"],"categories":[],"sub_categories":[],"readme":"# Python SEC\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Setup](#setup)\n- [Usage](#usage)\n- [Support These Projects](#support-these-projects)\n\n## Overview\n\nCurrent Version: **0.1.6**\n\nThe Securities \u0026 Exchange Commission (SEC) has a treasure trove of business data available to indviduals\nfor free. However, the biggest obstacle to getting this free data boils down to two challenges:\n\n1. Figuring out where it is\n2. Figuring out how to extract it\n\nThe Python SEC library (`edgar`) is designed to make the collection and the extraction of SEC data quick\nand effortless. The library was designed around some of the following goals:\n\n1. Making the usage of the EDGAR search system, in a prgorammatic fashion, more intuitive.\n2. Making the definition of queries more customizeable while still maintaining the overall clearity\n   of the library.\n3. Standardize the returning content so that content is organized consistently and ensuring gaps in data\n   are filled in or extended that way navigating to other directories or files can be done dynamically.\n4. Simplify the parsing of XBRL files so that data can be more easily manipulated.\n\n## Setup\n\n**Setup - PyPi Install:**\n\nTo **install** the library, run the following command from the terminal.\n\n```console\npip install python-sec\n```\n\n**Setup - PyPi Upgrade:**\n\nTo **upgrade** the library, run the following command from the terminal.\n\n```console\npip install --upgrade python-sec\n```\n\n**Setup - Local Install:**\n\nIf you are planning to make modifications to this project or you would like to access it\nbefore it has been indexed on `PyPi`. I would recommend you either install this project\nin `editable` mode or do a `local install`. For those of you, who want to make modifications\nto this project. I would recommend you install the library in `editable` mode.\n\nIf you want to install the library in `editable` mode, make sure to run the `setup.py`\nfile, so you can install any dependencies you may need. To run the `setup.py` file,\nrun the following command in your terminal.\n\n```console\npip install -e .\n```\n\nIf you don't plan to make any modifications to the project but still want to use it across\nyour different projects, then do a local install.\n\n```console\npip install .\n```\n\nThis will install all the dependencies listed in the `setup.py` file. Once done\nyou can use the library wherever you want.\n\n**Setup - PyPi Install:**\n\nTo install the library, run the following command from the terminal.\n\n```console\npip install python-sec\n```\n\n**Setup - PyPi Upgrade:**\n\nTo upgrade the library, run the following command from the terminal.\n\n```console\npip install --upgrade python-sec\n```\n\n## Usage\n\nHere is a simple example of using the `edgar` library to grab different groups of filings.\n\n```python\nfrom pprint import pprint\nfrom edgar.client import EdgarClient\nfrom edgar.enums import StateCodes\nfrom edgar.enums import CountryCodes\nfrom edgar.enums import StandardIndustrialClassificationCodes\n\n# Initialize the Edgar Client\nedgar_client = EdgarClient()\n\n# Initialize the Company Services.\ncompany_services = edgar_client.companies()\n\n# Grab all the companies that are based in Texas.\npprint(company_services.get_companies_by_state(state_code='TX'))\n\n# Alternatively, if you didn't know the 2 letter code you could pass through an Enum.\npprint(\n    company_services.get_companies_by_state(\n        state_code=StateCodes.West_Virginia\n    )\n)\n\n# Grab all the companies that are based in Australia, same logic here with the Enums.\npprint(\n    company_services.get_companies_by_country(\n        country_code=CountryCodes.AUSTRALIA\n    )\n)\n```\n\n## Support These Projects\n\n**Patreon:**\nHelp support this project and future projects by donating to my [Patreon Page](https://www.patreon.com/sigmacoding). I'm\nalways looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to\npay monthly fees.\n\n**YouTube:**\nIf you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).\n\n**Questions:**\nIf you have questions please feel free to reach out to me at [coding.sigma@gmail.com](mailto:coding.sigma@gmail.com?subject=[GitHub]%20Fred%20Library)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fareed1192%2Fpython-sec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fareed1192%2Fpython-sec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fareed1192%2Fpython-sec/lists"}