From 5c32c63829aa0c81cc176a33b5c2820d181e3941 Mon Sep 17 00:00:00 2001
From: Bryan Bugyi <bryanbugyi34@gmail.com>
Date: Mon, 15 Jan 2024 19:45:34 -0500
Subject: [PATCH] Initialize project by running `make all`

---
 README.md               |  27 ++++
 docs/source/modules.rst |   7 +
 docs/source/zorg.rst    |   7 +
 requirements-dev.in     |   2 +-
 requirements-dev.txt    | 287 ++++++++++++++++++++++++++++++++++++++++
 requirements.txt        |  32 +++++
 6 files changed, 361 insertions(+), 1 deletion(-)
 create mode 100644 docs/source/modules.rst
 create mode 100644 docs/source/zorg.rst
 create mode 100644 requirements-dev.txt
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index d40e16be..115cfaa3 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,33 @@ popen = subprocess.Popen(["zorg", "--help"], stdout=subprocess.PIPE)
 stdout, _ = popen.communicate()
 print("```", stdout.decode().strip(), "```", sep="\n")
 ]]]]] -->
+```
+usage: zorg [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v]
+
+Contains the zorg package's main entry point.
+
+optional arguments:
+  -c CONFIG_FILE, --config CONFIG_FILE
+                        Absolute or relative path to a YAML file that contains
+                        this application's configuration.
+  -h, --help            show this help message and exit
+  -L [FILE[:LEVEL][@FORMAT]], --log [FILE[:LEVEL][@FORMAT]]
+                        This option can be used to enable a new logging
+                        handler. FILE should be either a path to a logfile or
+                        one of the following special file types: [1] 'stderr'
+                        to log to standard error (enabled by default), [2]
+                        'stdout' to log to standard out, [3] 'null' to disable
+                        all console (e.g. stderr) handlers, or [4] '+[NAME]'
+                        to choose a default logfile path (where NAME is an
+                        optional basename for the logfile). LEVEL can be any
+                        valid log level (i.e. one of ['CRITICAL', 'DEBUG',
+                        'ERROR', 'INFO', 'TRACE', 'WARNING']) and FORMAT can
+                        be any valid log format (i.e. one of ['color', 'json',
+                        'nocolor']). NOTE: This option can be specified
+                        multiple times and has a default argument of '+'.
+  -v, --verbose         How verbose should the output be? This option can be
+                        specified multiple times (e.g. -v, -vv, -vvv, ...).
+```
 <!-- [[[[[end]]]]] -->
 
 <!-- [[[[[kooky.cog
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
new file mode 100644
index 00000000..6c190f46
--- /dev/null
+++ b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+zorg
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   zorg
diff --git a/docs/source/zorg.rst b/docs/source/zorg.rst
new file mode 100644
index 00000000..bd869ea1
--- /dev/null
+++ b/docs/source/zorg.rst
@@ -0,0 +1,7 @@
+zorg package
+============
+
+.. automodule:: zorg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/requirements-dev.in b/requirements-dev.in
index 6a60ce7c..fa409bd4 100644
--- a/requirements-dev.in
+++ b/requirements-dev.in
@@ -3,7 +3,7 @@ pytest
 pytest-cov
 pytest-mock
 syrupy
-tox
+tox < 4
 tox-pyenv
 -e file:.#egg=zettel-org>=0.dev
 
diff --git a/requirements-dev.txt b/requirements-dev.txt
new file mode 100644
index 00000000..a10a258e
--- /dev/null
+++ b/requirements-dev.txt
@@ -0,0 +1,287 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    "make update-requirements"
+#
+-e file:.#egg=zettel-org>=0.dev
+    # via -r requirements-dev.in
+alabaster==0.7.13
+    # via sphinx
+arrow==1.3.0
+    # via cookiecutter
+astroid==3.0.2
+    # via pylint
+babel==2.14.0
+    # via sphinx
+binaryornot==0.4.4
+    # via cookiecutter
+black==23.12.1
+    # via -r requirements-dev.in
+bolton-clack==0.3.4
+    # via
+    #   -r requirements.in
+    #   zettel-org
+bolton-eris==0.2.3
+    # via bolton-clack
+bolton-ion==0.1.0
+    # via bolton-eris
+bolton-logrus==0.1.0
+    # via
+    #   -r requirements.in
+    #   bolton-clack
+    #   zettel-org
+bolton-metaman==0.1.2
+    # via
+    #   bolton-eris
+    #   bolton-logrus
+bolton-typist==0.2.0
+    # via
+    #   bolton-clack
+    #   bolton-eris
+build==1.0.3
+    # via pip-tools
+bump2version==1.0.1
+    # via -r requirements-dev.in
+certifi==2023.11.17
+    # via requests
+chardet==5.2.0
+    # via binaryornot
+charset-normalizer==3.3.2
+    # via requests
+click==8.1.7
+    # via
+    #   black
+    #   cookiecutter
+    #   cruft
+    #   pip-tools
+    #   typer
+cogapp==3.3.0
+    # via -r requirements-dev.in
+cookiecutter==2.5.0
+    # via cruft
+coverage[toml]==7.4.0
+    # via
+    #   coverage
+    #   pytest-cov
+cruft[pyproject]==2.15.0
+    # via -r requirements-dev.in
+dill==0.3.7
+    # via pylint
+distlib==0.3.8
+    # via virtualenv
+docutils==0.20.1
+    # via
+    #   m2r2
+    #   sphinx
+    #   sphinx-rtd-theme
+exceptiongroup==1.2.0
+    # via pytest
+filelock==3.13.1
+    # via
+    #   tox
+    #   virtualenv
+flake8==7.0.0
+    # via -r requirements-dev.in
+gitdb==4.0.11
+    # via gitpython
+gitpython==3.1.41
+    # via cruft
+idna==3.6
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+importlib-metadata==7.0.1
+    # via
+    #   build
+    #   sphinx
+iniconfig==2.0.0
+    # via pytest
+isort==5.13.2
+    # via
+    #   -r requirements-dev.in
+    #   pylint
+jinja2==3.1.3
+    # via
+    #   cookiecutter
+    #   sphinx
+m2r2==0.3.3.post2
+    # via -r requirements-dev.in
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.3
+    # via jinja2
+mccabe==0.7.0
+    # via
+    #   flake8
+    #   pylint
+mdurl==0.1.2
+    # via markdown-it-py
+mistune==0.8.4
+    # via m2r2
+mypy==1.8.0
+    # via -r requirements-dev.in
+mypy-extensions==1.0.0
+    # via
+    #   black
+    #   mypy
+packaging==23.2
+    # via
+    #   black
+    #   build
+    #   pytest
+    #   setuptools-scm
+    #   sphinx
+    #   tox
+pathspec==0.12.1
+    # via black
+pip-tools==7.3.0
+    # via -r requirements-dev.in
+platformdirs==4.1.0
+    # via
+    #   black
+    #   pylint
+    #   virtualenv
+pluggy==1.3.0
+    # via
+    #   pytest
+    #   tox
+py==1.11.0
+    # via tox
+pycodestyle==2.11.1
+    # via flake8
+pydantic==1.10.13
+    # via bolton-clack
+pydocstyle[toml]==6.3.0
+    # via -r requirements-dev.in
+pyflakes==3.2.0
+    # via flake8
+pygments==2.17.2
+    # via
+    #   rich
+    #   sphinx
+pylint==3.0.3
+    # via -r requirements-dev.in
+pyproject-hooks==1.0.0
+    # via build
+pytest==7.4.4
+    # via
+    #   -r requirements-dev.in
+    #   pytest-cov
+    #   pytest-mock
+    #   syrupy
+pytest-cov==4.1.0
+    # via -r requirements-dev.in
+pytest-mock==3.12.0
+    # via -r requirements-dev.in
+python-dateutil==2.8.2
+    # via arrow
+python-slugify==8.0.1
+    # via cookiecutter
+pytz==2023.3.post1
+    # via babel
+pyyaml==6.0.1
+    # via
+    #   bolton-clack
+    #   cookiecutter
+requests==2.31.0
+    # via
+    #   cookiecutter
+    #   sphinx
+rich==13.7.0
+    # via cookiecutter
+setuptools-scm==8.0.4
+    # via -r requirements-dev.in
+six==1.16.0
+    # via
+    #   python-dateutil
+    #   tox
+smmap==5.0.1
+    # via gitdb
+snowballstemmer==2.2.0
+    # via
+    #   pydocstyle
+    #   sphinx
+sphinx==7.1.2
+    # via
+    #   -r requirements-dev.in
+    #   sphinx-autodoc-typehints
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-jquery
+sphinx-autodoc-typehints==1.25.2
+    # via -r requirements-dev.in
+sphinx-rtd-theme==2.0.0
+    # via -r requirements-dev.in
+sphinxcontrib-applehelp==1.0.4
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.1
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+structlog==24.1.0
+    # via bolton-logrus
+syrupy==4.6.0
+    # via -r requirements-dev.in
+text-unidecode==1.3
+    # via python-slugify
+toml==0.10.2
+    # via cruft
+tomli==2.0.1
+    # via
+    #   black
+    #   build
+    #   coverage
+    #   mypy
+    #   pip-tools
+    #   pydocstyle
+    #   pylint
+    #   pyproject-hooks
+    #   pytest
+    #   setuptools-scm
+    #   tox
+tomlkit==0.12.3
+    # via pylint
+tox==3.28.0
+    # via
+    #   -r requirements-dev.in
+    #   tox-pyenv
+tox-pyenv==1.1.0
+    # via -r requirements-dev.in
+typer==0.9.0
+    # via cruft
+types-python-dateutil==2.8.19.20240106
+    # via arrow
+typing-extensions==4.9.0
+    # via
+    #   astroid
+    #   black
+    #   mypy
+    #   pydantic
+    #   pylint
+    #   rich
+    #   setuptools-scm
+    #   typer
+urllib3==2.1.0
+    # via requests
+virtualenv==20.25.0
+    # via tox
+wheel==0.42.0
+    # via pip-tools
+zipp==3.17.0
+    # via importlib-metadata
+
+# The following packages are considered to be unsafe in a requirements file:
+pip==23.3.2
+    # via pip-tools
+setuptools==69.0.3
+    # via
+    #   pip-tools
+    #   setuptools-scm
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 00000000..69e07ab6
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,32 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    "make update-requirements"
+#
+bolton-clack==0.3.4
+    # via -r requirements.in
+bolton-eris==0.2.3
+    # via bolton-clack
+bolton-ion==0.1.0
+    # via bolton-eris
+bolton-logrus==0.1.0
+    # via
+    #   -r requirements.in
+    #   bolton-clack
+bolton-metaman==0.1.2
+    # via
+    #   bolton-eris
+    #   bolton-logrus
+bolton-typist==0.2.0
+    # via
+    #   bolton-clack
+    #   bolton-eris
+pydantic==1.10.13
+    # via bolton-clack
+pyyaml==6.0.1
+    # via bolton-clack
+structlog==24.1.0
+    # via bolton-logrus
+typing-extensions==4.9.0
+    # via pydantic