joop 0.0.1__tar.gz

joop-0.0.1/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: joop
+Version: 0.0.1
+Summary: Justin's Object-Oriented Paradigms
+License-Expression: Apache-2.0
+Keywords: object-oriented programming,DAO,HTMX,AlpineJS,Python
+Author: Justin Rushin
+Requires-Python: >=3.10
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Provides-Extra: flask
+Requires-Dist: click (>=7.0)
+Requires-Dist: flask (>=3.1.2,<4.0.0) ; extra == "flask"
+Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
+Requires-Dist: markupsafe (>=3.0.3,<4.0.0)
+Requires-Dist: pydantic (>=2.12.5,<3.0.0)
+Requires-Dist: sqlmodel (>=0.0.31,<0.0.32)
+Project-URL: Homepage, https://github.com/rushinjgr/joop
+Project-URL: bugs, https://github.com/rushinjgr/joop/issues
+Project-URL: changelog, https://github.com/rushinjgr/joop/blob/master/python/docs/changelog.md
+Project-URL: source, https://github.com/rushinjgr/joop
+Description-Content-Type: text/markdown
+
+# joop
+
+[![image](https://img.shields.io/pypi/v/joop.svg)](https://pypi.python.org/pypi/joop)
+
+**OOP Paradigms with an emphasis on DAO patterns, HTMX, and AlpineJS.**
+
+
+-   Free software: Apache Software License 2.0
+-   Documentation: https://rushinjgr.github.io/joop
+    
+
+## Features
+
+-   HTML Components for server-side rendering.
+
+## Getting Started
+
+### Setting Up a Virtual Environment
+
+It is recommended to use `poetry` to manage the virtual environment and dependencies. Follow these steps:
+
+1. Install `poetry` globally if it is not already installed:
+
+   ```bash
+   pip install poetry
+   ```
+
+2. Install the Poetry Shell plugin to enable the `poetry shell` command:
+
+   ```bash
+   poetry self add poetry-plugin-shell
+   ```
+
+3. Use `poetry` to install all dependencies (including development tools like `twine`):
+
+   ```bash
+   poetry install
+   ```
+
+   This will automatically create a virtual environment in the `.venv` folder inside the project directory, as specified in the `poetry.toml` file.
+
+4. To activate the virtual environment, use:
+
+   ```bash
+   poetry shell
+   ```
+
+### Build commands
+
+1. Run `poetry check` to validate the `pyproject.toml` file:
+
+   ```bash
+   poetry check
+   ```
+
+2. Build the package using `python -m build`:
+
+   ```bash
+   poetry run python -m build
+   ```
+
+   This will generate distribution files in the `dist/` directory.
+
+3. Verify the distribution files using `twine check`:
+
+   ```bash
+   poetry run twine check dist/*
+   ```
+
+   This ensures the distribution files are ready for upload to PyPI.
+
+### Building the Documentation
+
+To build the documentation, follow these steps:
+
+1. Ensure all dependencies, including development dependencies, are installed:
+   ```bash
+   poetry install --with dev
+   ```
+
+2. Build the documentation using Sphinx:
+   ```bash
+   poetry run sphinx-build -b html docs/source docs/build/html
+   ```
+
+   The generated HTML files will be located in the `docs/build/html` directory.
+
+3. Open the documentation in your browser by navigating to:
+   ```
+   docs/build/html/index.html
+   ```
+
+## Commands
+
+For all commands, run in `joop/python`
+
+To run the CLI: `python -m joop.cli`
+
+For tests, run `python -m unittest joop.tests` (add `-vvv` to see output)
+
+For coverage, run:
+```
+coverage run -m unittest joop.tests
+coverage report
+```
+

joop-0.0.1/README.md

@@ -0,0 +1,105 @@
+# joop
+
+[![image](https://img.shields.io/pypi/v/joop.svg)](https://pypi.python.org/pypi/joop)
+
+**OOP Paradigms with an emphasis on DAO patterns, HTMX, and AlpineJS.**
+
+
+-   Free software: Apache Software License 2.0
+-   Documentation: https://rushinjgr.github.io/joop
+    
+
+## Features
+
+-   HTML Components for server-side rendering.
+
+## Getting Started
+
+### Setting Up a Virtual Environment
+
+It is recommended to use `poetry` to manage the virtual environment and dependencies. Follow these steps:
+
+1. Install `poetry` globally if it is not already installed:
+
+   ```bash
+   pip install poetry
+   ```
+
+2. Install the Poetry Shell plugin to enable the `poetry shell` command:
+
+   ```bash
+   poetry self add poetry-plugin-shell
+   ```
+
+3. Use `poetry` to install all dependencies (including development tools like `twine`):
+
+   ```bash
+   poetry install
+   ```
+
+   This will automatically create a virtual environment in the `.venv` folder inside the project directory, as specified in the `poetry.toml` file.
+
+4. To activate the virtual environment, use:
+
+   ```bash
+   poetry shell
+   ```
+
+### Build commands
+
+1. Run `poetry check` to validate the `pyproject.toml` file:
+
+   ```bash
+   poetry check
+   ```
+
+2. Build the package using `python -m build`:
+
+   ```bash
+   poetry run python -m build
+   ```
+
+   This will generate distribution files in the `dist/` directory.
+
+3. Verify the distribution files using `twine check`:
+
+   ```bash
+   poetry run twine check dist/*
+   ```
+
+   This ensures the distribution files are ready for upload to PyPI.
+
+### Building the Documentation
+
+To build the documentation, follow these steps:
+
+1. Ensure all dependencies, including development dependencies, are installed:
+   ```bash
+   poetry install --with dev
+   ```
+
+2. Build the documentation using Sphinx:
+   ```bash
+   poetry run sphinx-build -b html docs/source docs/build/html
+   ```
+
+   The generated HTML files will be located in the `docs/build/html` directory.
+
+3. Open the documentation in your browser by navigating to:
+   ```
+   docs/build/html/index.html
+   ```
+
+## Commands
+
+For all commands, run in `joop/python`
+
+To run the CLI: `python -m joop.cli`
+
+For tests, run `python -m unittest joop.tests` (add `-vvv` to see output)
+
+For coverage, run:
+```
+coverage run -m unittest joop.tests
+coverage report
+```

joop-0.0.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

joop-0.0.1/docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 474cc4ab88352e7615a711e0b140e6d6
+tags: 645f666f9bcd5a90fca523b33c5a78b7

joop-0.0.1/docs/build/html/.buildinfo.bak

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ccb10a777262e7fe4df3af026abc7ca2
+tags: 645f666f9bcd5a90fca523b33c5a78b7

joop-0.0.1/docs/build/html/_autosummary/joop.cli.html

@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>joop.cli &#8212; joop 0.0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="joop.cli.test_flask" href="joop.cli.test_flask.html" />
+    <link rel="prev" title="joop.dao" href="joop.dao.html" />
+   
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  
+
+  
+  
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+  <section id="module-joop.cli">
+<span id="joop-cli"></span><h1>joop.cli<a class="headerlink" href="#module-joop.cli" title="Link to this heading">¶</a></h1>
+<p class="rubric">Modules</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="joop.cli.test_flask.html#module-joop.cli.test_flask" title="joop.cli.test_flask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_flask</span></code></a></p></td>
+<td><p>Flask testing module for joop.</p></td>
+</tr>
+</tbody>
+</table>
+</section>
+
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">joop</a></h1>
+
+
+
+
+
+
+
+
+
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../modules.html">API Documentation</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../modules.html#joop.hello_world"><code class="docutils literal notranslate"><span class="pre">hello_world()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.web.html">joop.web</a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.dao.html">joop.dao</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">joop.cli</a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.flask.html">joop.flask</a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.http.html">joop.http</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  <li><a href="../modules.html">API Documentation</a><ul>
+      <li>Previous: <a href="joop.dao.html" title="previous chapter">joop.dao</a></li>
+      <li>Next: <a href="joop.cli.test_flask.html" title="next chapter">joop.cli.test_flask</a></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2025, Justin Rushin.
+      
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+      
+      |
+      <a href="../_sources/_autosummary/joop.cli.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+    
+
+    
+  </body>
+</html>

joop-0.0.1/docs/build/html/_autosummary/joop.cli.test_flask.html

@@ -0,0 +1,153 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>joop.cli.test_flask &#8212; joop 0.0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="joop.flask" href="joop.flask.html" />
+    <link rel="prev" title="joop.cli" href="joop.cli.html" />
+   
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  
+
+  
+  
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+  <section id="module-joop.cli.test_flask">
+<span id="joop-cli-test-flask"></span><h1>joop.cli.test_flask<a class="headerlink" href="#module-joop.cli.test_flask" title="Link to this heading">¶</a></h1>
+<p>Flask testing module for joop.</p>
+<p>This module provides functionality to start a Flask webserver for testing and development purposes.</p>
+<dl class="simple">
+<dt>Important: The test joop env is set as the jinja env for the Flask server. This is specific and desirable</dt><dd><p>though your project may implement the environment otherwise.</p>
+</dd>
+<dt>Functions:</dt><dd><dl class="simple">
+<dt>start_test_flask():</dt><dd><p>Starts the Flask webserver in debug mode using the <cite>app</cite> instance from <cite>joop.flask</cite>.</p>
+</dd>
+</dl>
+</dd>
+<dt>Dependencies:</dt><dd><ul class="simple">
+<li><p>Flask: Ensure Flask is installed. If not, install it using <cite>pip install joop[flask]</cite>.</p></li>
+</ul>
+</dd>
+<dt>Usage:</dt><dd><ul class="simple">
+<li><p>Import the <cite>start_test_flask</cite> function and call it to start the Flask webserver.</p></li>
+</ul>
+</dd>
+</dl>
+<p class="rubric">Functions</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="#joop.cli.test_flask.start_test_flask" title="joop.cli.test_flask.start_test_flask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">start_test_flask</span></code></a>()</p></td>
+<td><p></p></td>
+</tr>
+</tbody>
+</table>
+<dl class="py function">
+<dt class="sig sig-object py" id="joop.cli.test_flask.start_test_flask">
+<span class="sig-prename descclassname"><span class="pre">joop.cli.test_flask.</span></span><span class="sig-name descname"><span class="pre">start_test_flask</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/joop/cli/test_flask.html#start_test_flask"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#joop.cli.test_flask.start_test_flask" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</section>
+
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">joop</a></h1>
+
+
+
+
+
+
+
+
+
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../modules.html">API Documentation</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../modules.html#joop.hello_world"><code class="docutils literal notranslate"><span class="pre">hello_world()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.web.html">joop.web</a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.dao.html">joop.dao</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="joop.cli.html">joop.cli</a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.flask.html">joop.flask</a></li>
+<li class="toctree-l2"><a class="reference internal" href="joop.http.html">joop.http</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  <li><a href="../modules.html">API Documentation</a><ul>
+  <li><a href="joop.cli.html">joop.cli</a><ul>
+      <li>Previous: <a href="joop.cli.html" title="previous chapter">joop.cli</a></li>
+      <li>Next: <a href="joop.flask.html" title="next chapter">joop.flask</a></li>
+  </ul></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2025, Justin Rushin.
+      
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+      
+      |
+      <a href="../_sources/_autosummary/joop.cli.test_flask.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+    
+
+    
+  </body>
+</html>