Prepare for open source

.github/workflows/ci.yml

@@ -93,29 +93,33 @@ jobs:
           --spec tox==${{ env.TOX_VERSION }}
           tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
           -- -rFEx --durations 10 --color yes
-  package:
-    needs: [test, prepare]
-    strategy:
-      matrix:
-        platform:
-        - ubuntu-24.04
-        - windows-2022
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-            fetch-depth: 0  # deep clone for setuptools-scm
-      - uses: actions/setup-python@v5
-        id: setup-python
-        with:
-          python-version: ${{ env.MAX_PYTHON_VERSION }}
 
   release:
     if: startsWith(github.ref, 'refs/tags/')
-    needs: [package, prepare]
+    needs: [test, prepare]
     runs-on: ubuntu-24.04
     steps:
       - name: Release
         uses: softprops/action-gh-release@v2
         with:
           generate_release_notes: true
+
+  publish-to-pypi:
+    name: >-
+      Publish Python distribution to PyPI
+    needs:
+    - release
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/lob-hlpr  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing
+
+To contribute there are a few simple rules to follow.
+
+- Run `pre-commit` checks
+- Make sure everything has 100% coverage and all tests pass
+- No dependencies
+- Open a PR first... This was the CI can verify your work.

LICENSE

@@ -1,2 +1,21 @@
-Copyright (c) 2025 by Lobaro GmbH
-All rights reserved.
+The MIT License (MIT)
+
+Copyright (c) 2025 Lobaro GmbH
+
+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.

README.md

@@ -1,3 +1,19 @@
 ## lob-hlpr
 
 Simple python based helpers for lobaro tools.
+
+This package does not have any dependencies and should easily integrate into
+other packages.
+
+## Installation
+
+This package should be available in `pypi` and can be installed with `pip` or
+as a dependency.
+
+## Contributing
+
+This package is really only meant for Lobaro, however, other may find it useful
+and can contribute to it.
+Before doing so read
+[contributing guide](https://github.com/astral-sh/uv/blob/main/CONTRIBUTING.md)
+to get started.

pyproject.toml

@@ -12,7 +12,7 @@ description = "Simple python based helpers for lobaro tools."
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [
-  { name = "", email = "weiss.kevin604@gmail.com" },
+  { name = "Kevin Weiss", email = "weiss.kevin604@gmail.com" },
 ]
 requires-python = ">=3.10"
 classifiers = [