Package: python-sec
Python SECTable of ContentsOverviewSetupUsageSupport These ProjectsOverviewCurrent Version:0.1.6The Securities & Exchange Commission (SEC) has a treasure trove of business data available to indviduals
for free. However, the biggest obstacle to getting this free data boils down to two challenges:Figuring out where it isFiguring out how to extract itThe Python SEC library (edgar) is designed to make the collection and the extraction of SEC data quick
and effortless. The library was designed around some of the following goals:Making the usage of the EDGAR search system, in a prgorammatic fashion, more intuitive.Making the definition of queries more customizeable while still maintaining the overall clearity
of the library.Standardize the returning content so that content is organized consistently and ensuring gaps in data
are filled in or extended that way navigating to other directories or files can be done dynamically.Simplify the parsing of XBRL files so that data can be more easily manipulated.SetupSetup - PyPi Install:Toinstallthe library, run the following command from the terminal.pip install python-secSetup - PyPi Upgrade:Toupgradethe library, run the following command from the terminal.pip install --upgrade python-secSetup - Local Install:If you are planning to make modifications to this project or you would like to access it
before it has been indexed onPyPi. I would recommend you either install this project
ineditablemode or do alocal install. For those of you, who want to make modifications
to this project. I would recommend you install the library ineditablemode.If you want to install the library ineditablemode, make sure to run thesetup.pyfile, so you can install any dependencies you may need. To run thesetup.pyfile,
run the following command in your terminal.pip install -e .If you don't plan to make any modifications to the project but still want to use it across
your different projects, then do a local install.pip install .This will install all the dependencies listed in thesetup.pyfile. Once done
you can use the library wherever you want.Setup - PyPi Install:To install the library, run the following command from the terminal.pip install python-secSetup - PyPi Upgrade:To upgrade the library, run the following command from the terminal.pip install --upgrade python-secUsageHere is a simple example of using theedgarlibrary to grab different groups of filings.frompprintimportpprintfromedgar.clientimportEdgarClientfromedgar.enumsimportStateCodesfromedgar.enumsimportCountryCodesfromedgar.enumsimportStandardIndustrialClassificationCodes# Initialize the Edgar Clientedgar_client=EdgarClient()# Initialize the Company Services.company_services=edgar_client.companies()# Grab all the companies that are based in Texas.pprint(company_services.get_companies_by_state(state_code='TX'))# Alternatively, if you didn't know the 2 letter code you could pass through an Enum.pprint(company_services.get_companies_by_state(state_code=StateCodes.West_Virginia))# Grab all the companies that are based in Australia, same logic here with the Enums.pprint(company_services.get_companies_by_country(country_code=CountryCodes.AUSTRALIA))Support These ProjectsPatreon:Help support this project and future projects by donating to myPatreon Page. I'm
always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to
pay monthly fees.YouTube:If you'd like to watch more of my content, feel free to visit my YouTube channelSigma Coding.Questions:If you have questions please feel free to reach out to me atcoding.sigma@gmail.com