diff --git a/Taskfile.yml b/Taskfile.yml
index 95a8f1c..c6a4c6a 100644
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -85,3 +85,32 @@ tasks:
cmds:
- poetry run cz bump {{.CLI_ARGS}}
- poetry export --with doc -f requirements.txt --output docs/rtd_requirements.txt
+
+ check-and-push:
+ cmds:
+ - task: pre-push-checks
+ - git push
+
+######################################
+### Shorthand Tasks for Efficiency ###
+######################################
+
+ c: # You can just run `task c` instead of `task pre-commit-checks`.
+ deps:
+ - pre-commit-checks
+
+ p: # You can just run `task pp` instead of `task pre-push-checks`.
+ deps:
+ - pre-push-checks
+
+ pp: # You can just run `task pp` instead of `task check-and-push`.
+ deps:
+ - check-and-push
+
+ d: # You can just run `task d` instead of `task launch-debug-dashboard`.
+ deps:
+ - launch-debug-dashboard
+
+ m: # You can just run `task m` instead of `task monitor-unit-tests`.
+ deps:
+ - monitor-unit-tests
diff --git a/docs/source/notebooks/developer_guide.ipynb b/docs/source/notebooks/developer_guide.ipynb
index 70379fe..dd5d539 100644
--- a/docs/source/notebooks/developer_guide.ipynb
+++ b/docs/source/notebooks/developer_guide.ipynb
@@ -1,110 +1,110 @@
{
- "cells": [
- {
- "cell_type": "code",
- "execution_count": 1,
- "metadata": {
- "nbsphinx": "hidden"
- },
- "outputs": [
- {
- "data": {
- "text/html": [
- "\n",
- " \n",
- " "
- ],
- "text/plain": [
- ""
- ]
- },
- "metadata": {},
- "output_type": "display_data"
- }
- ],
- "source": [
- "# This will auto-format your code. You can optionally install 'jupyter-black' using pip.\n",
- "# Note: this cell is hidden from the HTML output. Read more: https://nbsphinx.readthedocs.io/en/0.2.1/hidden-cells.html\n",
- "try:\n",
- " import jupyter_black\n",
- " jupyter_black.load()\n",
- "except ImportError:\n",
- " pass"
- ]
- },
- {
- "attachments": {},
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "# Developer Guide: Comprehensive Overview"
- ]
- },
- {
- "attachments": {},
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "Welcome to the Comprehensive Developer Guide for `sec-ai`. This guide is designed to provide an in-depth understanding of the `sec-ai` project, whether you're a new developer looking to contribute, or an experienced one seeking to leverage its capabilities. We'll walk you through the codebase, explaining key components and their interactions, and provide examples to help you get started. \n",
- "\n",
- "This guide is interactive, allowing you to engage with the code and concepts as you learn. You can run and modify all the code examples shown here for yourself by cloning the repository and running the [developer_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/developer_guide.ipynb) in a Jupyter notebook. \n",
- "\n",
- "Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
- "\n",
- "[](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/developer_guide.ipynb)\n",
- "[](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/developer_guide.ipynb)\n",
- "\n",
- "Let's dive in!"
- ]
- },
- {
- "attachments": {},
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## 🚧 Under Construction 🚧\n",
- "We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).\n",
- "\n",
- "Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.\n",
- "\n",
- "**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.\n",
- "\n",
- "Thank you for your interest and we look forward to sharing our progress with you soon."
- ]
- }
- ],
- "metadata": {
- "kernelspec": {
- "display_name": ".venv",
- "language": "python",
- "name": "python3"
- },
- "language_info": {
- "codemirror_mode": {
- "name": "ipython",
- "version": 3
- },
- "file_extension": ".py",
- "mimetype": "text/x-python",
- "name": "python",
- "nbconvert_exporter": "python",
- "pygments_lexer": "ipython3",
- "version": "3.11.4"
- },
- "orig_nbformat": 4
- },
- "nbformat": 4,
- "nbformat_minor": 2
+ "cells": [
+ {
+ "cell_type": "code",
+ "execution_count": 1,
+ "metadata": {
+ "nbsphinx": "hidden"
+ },
+ "outputs": [
+ {
+ "data": {
+ "text/html": [
+ "\n",
+ " \n",
+ " "
+ ],
+ "text/plain": [
+ ""
+ ]
+ },
+ "metadata": {},
+ "output_type": "display_data"
+ }
+ ],
+ "source": [
+ "# This will auto-format your code. You can optionally install 'jupyter-black' using pip.\n",
+ "# Note: this cell is hidden from the HTML output. Read more: https://nbsphinx.readthedocs.io/en/0.2.1/hidden-cells.html\n",
+ "try:\n",
+ " import jupyter_black\n",
+ " jupyter_black.load()\n",
+ "except ImportError:\n",
+ " pass"
+ ]
+ },
+ {
+ "attachments": {},
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Developer Guide: Comprehensive Overview"
+ ]
+ },
+ {
+ "attachments": {},
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "Welcome to the Comprehensive Developer Guide for `sec-ai`. This guide is designed to provide an in-depth understanding of the `sec-ai` project, whether you're a new developer looking to contribute, or an experienced one seeking to leverage its capabilities. We'll walk you through the codebase, explaining key components and their interactions, and provide examples to help you get started. \n",
+ "\n",
+ "This guide is interactive, allowing you to engage with the code and concepts as you learn. You can run and modify all the code examples shown here for yourself by cloning the repository and running the [developer_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/developer_guide.ipynb) in a Jupyter notebook. \n",
+ "\n",
+ "Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
+ "\n",
+ "[](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/developer_guide.ipynb)\n",
+ "[](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/developer_guide.ipynb)\n",
+ "\n",
+ "Let's dive in!"
+ ]
+ },
+ {
+ "attachments": {},
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 🚧 Under Construction 🚧\n",
+ "We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).\n",
+ "\n",
+ "Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.\n",
+ "\n",
+ "**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.\n",
+ "\n",
+ "Thank you for your interest and we look forward to sharing our progress with you soon."
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": ".venv",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.11.4"
+ },
+ "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
}
diff --git a/docs/source/notebooks/user_guide.ipynb b/docs/source/notebooks/user_guide.ipynb
index de73054..8663336 100644
--- a/docs/source/notebooks/user_guide.ipynb
+++ b/docs/source/notebooks/user_guide.ipynb
@@ -1,110 +1,110 @@
{
- "cells": [
- {
- "cell_type": "code",
- "execution_count": 1,
- "metadata": {
- "nbsphinx": "hidden"
- },
- "outputs": [
- {
- "data": {
- "text/html": [
- "\n",
- " \n",
- " "
- ],
- "text/plain": [
- ""
- ]
- },
- "metadata": {},
- "output_type": "display_data"
- }
- ],
- "source": [
- "# This will auto-format your code. You can optionally install 'jupyter-black' using pip.\n",
- "# Note: this cell is hidden from the HTML output. Read more: https://nbsphinx.readthedocs.io/en/0.2.1/hidden-cells.html\n",
- "try:\n",
- " import jupyter_black\n",
- " jupyter_black.load()\n",
- "except ImportError:\n",
- " pass"
- ]
- },
- {
- "attachments": {},
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "# User Guide: Quick Start"
- ]
- },
- {
- "attachments": {},
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "Welcome to the Quickstart User Guide for `sec-ai`! This guide is designed to walk you through the fundamental steps needed to install and use the library for using the comprehensive toolset for analyzing and interpreting data from SEC filings. Whether you're a financial analyst, a data scientist, or someone interested in SEC filings, this guide provides examples and code snippets to help you get started.\n",
- "\n",
- "This guide is interactive, allowing you to engage with the code and concepts as you learn. You can run and modify all the code examples shown here for yourself by cloning the repository and running the [user_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/user_guide.ipynb) in a Jupyter notebook.\n",
- "\n",
- "Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
- "\n",
- "[](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/user_guide.ipynb)\n",
- "[](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/user_guide.ipynb)\n",
- "\n",
- "Let's get started!"
- ]
- },
- {
- "attachments": {},
- "cell_type": "markdown",
- "metadata": {},
- "source": [
- "## 🚧 Under Construction 🚧\n",
- "We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).\n",
- "\n",
- "Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.\n",
- "\n",
- "**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.\n",
- "\n",
- "Thank you for your interest and we look forward to sharing our progress with you soon."
- ]
- }
- ],
- "metadata": {
- "kernelspec": {
- "display_name": ".venv",
- "language": "python",
- "name": "python3"
- },
- "language_info": {
- "codemirror_mode": {
- "name": "ipython",
- "version": 3
- },
- "file_extension": ".py",
- "mimetype": "text/x-python",
- "name": "python",
- "nbconvert_exporter": "python",
- "pygments_lexer": "ipython3",
- "version": "3.11.4"
- },
- "orig_nbformat": 4
- },
- "nbformat": 4,
- "nbformat_minor": 2
+ "cells": [
+ {
+ "cell_type": "code",
+ "execution_count": 1,
+ "metadata": {
+ "nbsphinx": "hidden"
+ },
+ "outputs": [
+ {
+ "data": {
+ "text/html": [
+ "\n",
+ " \n",
+ " "
+ ],
+ "text/plain": [
+ ""
+ ]
+ },
+ "metadata": {},
+ "output_type": "display_data"
+ }
+ ],
+ "source": [
+ "# This will auto-format your code. You can optionally install 'jupyter-black' using pip.\n",
+ "# Note: this cell is hidden from the HTML output. Read more: https://nbsphinx.readthedocs.io/en/0.2.1/hidden-cells.html\n",
+ "try:\n",
+ " import jupyter_black\n",
+ " jupyter_black.load()\n",
+ "except ImportError:\n",
+ " pass"
+ ]
+ },
+ {
+ "attachments": {},
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# User Guide: Quick Start"
+ ]
+ },
+ {
+ "attachments": {},
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "Welcome to the Quickstart User Guide for `sec-ai`! This guide is designed to walk you through the fundamental steps needed to install and use the library for using the comprehensive toolset for analyzing and interpreting data from SEC filings. Whether you're a financial analyst, a data scientist, or someone interested in SEC filings, this guide provides examples and code snippets to help you get started.\n",
+ "\n",
+ "This guide is interactive, allowing you to engage with the code and concepts as you learn. You can run and modify all the code examples shown here for yourself by cloning the repository and running the [user_guide.ipynb](https://github.com/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/user_guide.ipynb) in a Jupyter notebook.\n",
+ "\n",
+ "Alternatively, you can also run the notebook directly in your browser using Google Colab:\n",
+ "\n",
+ "[](https://colab.research.google.com/github/alphanome-ai/sec-ai/blob/main/docs/source/notebooks/user_guide.ipynb)\n",
+ "[](https://mybinder.org/v2/gh/alphanome-ai/sec-ai/main?filepath=docs/source/notebooks/user_guide.ipynb)\n",
+ "\n",
+ "Let's get started!"
+ ]
+ },
+ {
+ "attachments": {},
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## 🚧 Under Construction 🚧\n",
+ "We are currently finalizing a few key prerequisites for `sec-ai` within our [**sec-parser**](https://github.com/alphanome-ai/sec-parser) project, as detailed in our [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans).\n",
+ "\n",
+ "Your anticipation for the launch of `sec-ai` is greatly appreciated. We are working diligently to ensure that `sec-ai` is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when `sec-ai` is ready, please follow our [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) page.\n",
+ "\n",
+ "**Get Involved**: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our [**sec-parser/CONTRIBUTING.md**](https://github.com/alphanome-ai/sec-parser/blob/main/CONTRIBUTING.md) guide for details on how to get started.\n",
+ "\n",
+ "Thank you for your interest and we look forward to sharing our progress with you soon."
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": ".venv",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.11.4"
+ },
+ "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
}