feat: First release (#1)

* Add docs image
* Add license
* Update pyproject.toml in prep for release
* Add github actions

Author: automas-dev

.github/workflows/ci.yml

@@ -0,0 +1,79 @@
+name: ci
+
+on:
+  push:
+    branch:
+
+jobs:
+  lint_test:
+    name: Lint & Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: twh2898/reusable-workflows/setup_python@main
+        with:
+          python-version: "3.12"
+          poetry-version: "1.8.5"
+
+      - name: Install Dependencies
+        run: poetry install
+
+      - name: Lint
+        run: poetry run ruff check .
+
+      # - name: Test
+      #   run: poetry run pytest tests --cov=src --cov-branch --cov-fail-under=100
+
+  build_release:
+    name: Build Release
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, 'NO RELEASE')
+
+    needs: lint_test
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Increment Version
+        uses: twh2898/reusable-workflows/increment_version@main
+        id: version
+
+      - name: Setup Python
+        uses: twh2898/reusable-workflows/setup_python@main
+        with:
+          python-version: "3.12"
+          poetry-version: "1.8.5"
+
+      - name: Install Dependencies
+        run: poetry install
+
+      - name: Set version
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          poetry version $VERSION
+
+      - name: Build Release
+        run: |
+          poetry build
+
+      - name: Create Release
+        uses: ncipollo/release-action@v1.14.0
+        with:
+          artifacts: "dist/*.whl"
+          makeLatest: true
+          generateReleaseNotes: true
+          tag: ${{ steps.version.outputs.version }}
+
+      # - name: Publish Package
+      #   env:
+      #     PYPI_TOKEN: ${{ secrets.PYPI_KEY }}
+      #   run: |
+      #     poetry config pypi-token.pypi $PYPI_TOKEN
+      #     poetry publish

.gitignore

@@ -97,3 +97,4 @@ dmypy.json
 cython_debug/
 
 *.png
+!docs/*.png

LICENSE

@@ -0,0 +1,18 @@
+Copyright 2025 Thomas Harrison <theharrisoncrafter@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.