Merge pull request #121 from georgian-io/github-ci-pypi

[CI] Publish to PyPI upon Tag

Author: benjaminye

.github/workflows/lint_and_format.yml

@@ -2,7 +2,7 @@ name: Ruff
 on: pull_request
 jobs:
   lint:
-    name: Lint, Format, and Commit
+    name: Lint & Format
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/publish_pypi.yml

@@ -0,0 +1,46 @@
+name: PyPI CD
+on:
+  release:
+    types: [published]
+jobs:
+  pypi:
+    name: Build and Upload Release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/llm-toolkit
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      # ----------------
+      # Set Up
+      # ----------------
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      # ----------------
+      # Install Deps
+      # ----------------
+      - name: Install Dependencies
+        run: |
+          poetry install --no-interaction --no-root
+          poetry self add "poetry-dynamic-versioning[plugin]"
+      # ----------------
+      # Build & Publish
+      # ----------------
+      - name: Build
+        run: poetry build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

llmtune/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2024 Georgian Partners
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "0.0.0"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "llm-toolkit"
-version = "0.1.0"
+version = "0.0.0"
 description = "LLM Finetuning resource hub + toolkit"
 authors = ["Benjamin Ye <[email protected]>"]
 license = "Apache 2.0"
@@ -10,6 +10,16 @@ packages = [{include = "llmtune"}]
 [tool.poetry.scripts]
 llmtune = "llmtune.cli.toolkit:cli"
 
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
+style = "semver"
+
+[tool.poetry-dynamic-versioning.substitution]
+folders = [
+  { path = "llmtune" }
+]
+
 [tool.poetry.dependencies]
 python = ">=3.9, <=3.12"
 transformers = "~4.37.2"
@@ -49,8 +59,8 @@ shellingham = "^1.5.4"
 ruff = "~0.3.5"
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
 
 [tool.ruff]
 lint.ignore = ["C901", "E501", "E741", "F402", "F823" ]