joop 0.0.1__py3-none-any.whl

joop-0.0.1.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,31 @@
+joop/__init__.py,sha256=tcUhqXRMmCnkqsK80Ag0Cy5WuXpcq25ffcr2Lj3jBUA,196
+joop/abstract/README.md,sha256=Np27MGN-nseV3p4-oYGud79ykKKg74dqiI15kBI_DPc,162
+joop/abstract/__init__.py,sha256=A7JqwtHk94fbV0BhFhHkwuCs_WUrctUxA2ZYoZHso3w,3079
+joop/cli/README.md,sha256=FTNqymKClBR7quGaD0gidU5lnRMuZJKmlb3MQdi7DDQ,202
+joop/cli/__init__.py,sha256=iczWnKeZNGrIqQLPhZU-KEMivlVULPGaFQ5fpXQChIQ,34
+joop/cli/__main__.py,sha256=hZiww8R1o01VldXC3XVIsNz8c4Nm2OvlOAxKCcEsI5g,1186
+joop/cli/test_flask.py,sha256=lxikHs8c_RSGFVwMYwOpCm0LyypGxExJuNK98I3caDs,1011
+joop/dao/__init__.py,sha256=wwk9OvHt1nRw4RJXscRIkXp0vOzwgHweIPytSVTHwus,5239
+joop/flask/__init__.py,sha256=CkAdeS3sD7z5hSiQC0VNS1JA6TQBlXIScBmXCMIMpNA,945
+joop/flask/example.py,sha256=R8BvbiKOMhsxtF7zN9a2F_mXd5YFtKHSLar7O1f4FlM,417
+joop/flask/flask_view.py,sha256=XMaD5vAWWo6sEeHUqMIdz-LNv3I3rZbaN12Qx5yL2Zs,2398
+joop/http/methods.py,sha256=12Y87zR7vHXtCwg9ravSn9NDCq6dsR1UiQ7aM5Q1d2s,1775
+joop/tests/__init__.py,sha256=H0axufHJO_TulEi4OR03ZFenjcgr3dVe5vKe7qGv2rA,163
+joop/tests/test_joop.py,sha256=2tzKbfT2EVnOCxwVbfu2sCAmVdh37IxMEGJWcGlhXdc,785
+joop/tests/test_templater.py,sha256=-DVOMiPuA7sO2lGQVvD7wngIDUXAL-OEKYE11_9TEFQ,791
+joop/tests/test_view.py,sha256=G0N6DQrgSKPhRW3T13NbrDvbynVayt-bvRW2Q0Qd4Pc,1270
+joop/tests/test_web.py,sha256=RrvuVj0VmyjDbpvvdJVv5DnbpEzbP6ky6E0CA4QMpsk,2493
+joop/web/__init__.py,sha256=SXfAxuh96-w1uxlHd2NMfn7ThrSGOUU84cCXiZX6JzM,412
+joop/web/component.py,sha256=oZO9tVhlXAlF4tn8tmtHp95SlPuD6-q8gezWOU4l9y0,5135
+joop/web/components.py,sha256=74EUiZOO9yCJnFQYYyRREvZKeRsKgYpAJIHkzQdJ_vY,3772
+joop/web/examples/hello.py,sha256=29c5EUjIZgHiD5-O5KC_40sO9D2Tg69QBvvOPLfQ4Qg,4824
+joop/web/examples/table.py,sha256=jshGjwh66MIbQRkSgKYkzzeLViUU6ULwsTVOxEZbCzs,4697
+joop/web/examples/view.py,sha256=FwKPeXqJ6CpJxdEGQohGS2yhPH8H2TBMem8vHkp2ZME,655
+joop/web/html.py,sha256=O2Xo_xGeO-ro62Wc_8q__WUS29G0uF5axYvQF3IqSNk,7690
+joop/web/j_env.py,sha256=Pj-DIVUFd4Rb_wSAqT3nfyyKtR9cW6kzCHSxF1d7BTg,1093
+joop/web/templater.py,sha256=SnlSj0mf83KUiCWTh4-6s3UQtmrsFDngbqENZjc1SPQ,5010
+joop/web/view.py,sha256=9DU_i1Hpeai_NDuhf17mGF0xoIUV7aSLE3zoisoRUGA,6833
+joop-0.0.1.dist-info/METADATA,sha256=rAoKQXNlx73rx2_1lqFFKgSGSEs6Yd_WmiqAq7AzcCo,3411
+joop-0.0.1.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+joop-0.0.1.dist-info/entry_points.txt,sha256=EXfYHkMxWW2P6AJ4sLEljXmhALjKMGlyta2NNIPDtQw,38
+joop-0.0.1.dist-info/RECORD,,

joop-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.1
+Root-Is-Purelib: true
+Tag: py3-none-any

joop-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+joop=joop.cli:main
+