| Name | datadock JSON |
| Version |
2.0.10
JSON |
| download |
| home_page | None |
| Summary | DataDock python library to access SEC edgar fillings. |
| upload_time | 2025-01-21 11:42:38 |
| maintainer | None |
| docs_url | None |
| author | Peter Mbachu |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
datadockpy
datadockai
python
sec
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DataDockPy Library
----------------
## Introduction
`datadock` 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](https://rich.readthedocs.io/en/stable/introduction.html) & [tabulate](https://github.com/astanin/python-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 `datadock`.
### Using pip command to install `datadock`
```commandline
pip install datadock
```
### Using Poetry to install `datadock`
1. Open your terminal and install poetry _[if you do not have poetry]_ using `pip`.
```commandline
pip install poetry
```
or Install poetry using `pipx`.
```commandline
pipx install poetry
```
or Install using `curl`
```commandline
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
```commandline
poetry new project_name
```
3. Change directory to your project
```commandline
cd project_name
```
4. Run the poetry command to add `datadock`:
```commandline
poetry add datadock
```
## Use DataDockPy with Jupyter
------------
1. Open notebook in your project and install `datadock` using `pip` command in your kernel.
```bash
pip install datadock
```
----------------------------------
## Set up `SEC_IDENTITY` environment variable in a `.env` file in your project.
```dotenv
SEC_IDENTITY=<your sec identity here>
```
-----------------------------
## How to use the latest version of `datadock` in your terminal.
```commandline
pip install --upgrade datadock
```
or
```commandline
pip install datadock==<latest version number here>
```
----------
## Do you have any issue or want to contribute to `datadock` library?
If you have any issue or contribution, please write an issue with this link: https://github.com/DataDock-AI/DataDockPy/issues
Raw data
{
"_id": null,
"home_page": null,
"name": "datadock",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "datadockpy, datadockAI, python, SEC",
"author": "Peter Mbachu",
"author_email": "peter.mbachu@datadock.ai",
"download_url": "https://files.pythonhosted.org/packages/df/f9/0b306be91c6d54d2e1942be3d5378091d2c5f0ccd2794c607d4859e96eaf/datadock-2.0.10.tar.gz",
"platform": null,
"description": "# DataDockPy Library \n\n----------------\n\n \n \n\n\n\n\n## Introduction\n\n`datadock` is a powerful and user-friendly Python package designed to enhance data analysis. \nIt simplifies the extraction and presentation of information for various forms from the SEC website, \noffering enriched data display for SEC form types, filing details, and financial statements, \nmaking it an essential tool for professionals working with regulatory filings.\n\n\n## Features\n\n- \ud83d\udcc1 **Access any SEC filing**: You can access any filings on SEC forms of Form 8-K and Form 10-K etc.\n- \ud83d\udcc5 **List filings for any date range**: List filings by date e.g. or date range `2024-02-29:2024-03-15`\n- \ud83c\udf1f **User Friendly library**: Uses **[rich](https://rich.readthedocs.io/en/stable/introduction.html) & [tabulate](https://github.com/astanin/python-tabulate)** library to display SEC Edgar data in a beautiful way.\n- \ud83c\udfd7\ufe0f **Filter filings data**: Build data filtering by cik, accession number, form type, filing date\n- \ud83d\udd0d **Preview the text data for a filing**: You can preview the filing (sections) in the terminal or a notebook.\n- \ud83d\udcca **Parse to Dataframe**: You can parse filings to a dataframe.\n- \ud83d\udcc8 **Financial Statement**: Get financial statements of Form 8-K and Form 10-K of various companies.\n\n\n## Get Started on Windows/MacOS/Linux Terminal\n\n-------\n\nYou can use `Poetry` or any dependency manager or use the general `pip install` command to install `datadock`.\n\n### Using pip command to install `datadock`\n\n```commandline\npip install datadock\n```\n\n### Using Poetry to install `datadock`\n\n\n1. Open your terminal and install poetry _[if you do not have poetry]_ using `pip`.\n \n ```commandline\n pip install poetry\n ```\n or Install poetry using `pipx`.\n \n ```commandline \n pipx install poetry\n ```\n or Install using `curl`\n\n ```commandline\n curl -sSL https://install.python-poetry.org | python3 -\n ```\n\n2. Create a project using poetry command. This will create a `pyproject.TOML` in your project.\nFollow the instructions to finish creating your project\n\n ```commandline\n poetry new project_name\n ```\n\n3. Change directory to your project\n\n ```commandline\n cd project_name\n ```\n\n4. Run the poetry command to add `datadock`: \n\n ```commandline\n poetry add datadock\n ```\n\n\n## Use DataDockPy with Jupyter\n\n------------\n\n1. Open notebook in your project and install `datadock` using `pip` command in your kernel.\n \n ```bash\n pip install datadock\n ```\n\n----------------------------------\n\n\n## Set up `SEC_IDENTITY` environment variable in a `.env` file in your project.\n\n ```dotenv\n SEC_IDENTITY=<your sec identity here>\n ```\n\n-----------------------------\n\n## How to use the latest version of `datadock` in your terminal.\n\n ```commandline\n pip install --upgrade datadock\n ```\n\nor\n\n ```commandline\n pip install datadock==<latest version number here> \n ```\n\n----------\n\n## Do you have any issue or want to contribute to `datadock` library?\n\nIf you have any issue or contribution, please write an issue with this link: https://github.com/DataDock-AI/DataDockPy/issues\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DataDock python library to access SEC edgar fillings.",
"version": "2.0.10",
"project_urls": null,
"split_keywords": [
"datadockpy",
" datadockai",
" python",
" sec"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b654be9841bbcb5084206b09bdff6b93453410f7a547506fefe2193dd27bfe2",
"md5": "e671d47afacf8de251c748ef5554de91",
"sha256": "65bbeae5be8c81e47c0223f80f38f1ecb8e9446ef0e5065a28fb550f4ccf14aa"
},
"downloads": -1,
"filename": "datadock-2.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e671d47afacf8de251c748ef5554de91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 75915,
"upload_time": "2025-01-21T11:42:36",
"upload_time_iso_8601": "2025-01-21T11:42:36.501298Z",
"url": "https://files.pythonhosted.org/packages/8b/65/4be9841bbcb5084206b09bdff6b93453410f7a547506fefe2193dd27bfe2/datadock-2.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dff90b306be91c6d54d2e1942be3d5378091d2c5f0ccd2794c607d4859e96eaf",
"md5": "ce76f4ac5a83f22b63c994073afcd0f3",
"sha256": "82c8c0314ae01d931cfcd23716514433ef6b4e4a4d156f268cb9630c6678d15a"
},
"downloads": -1,
"filename": "datadock-2.0.10.tar.gz",
"has_sig": false,
"md5_digest": "ce76f4ac5a83f22b63c994073afcd0f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 59650,
"upload_time": "2025-01-21T11:42:38",
"upload_time_iso_8601": "2025-01-21T11:42:38.118574Z",
"url": "https://files.pythonhosted.org/packages/df/f9/0b306be91c6d54d2e1942be3d5378091d2c5f0ccd2794c607d4859e96eaf/datadock-2.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 11:42:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "datadock"
}
