Refactor repository to deploy as WHEEL via Github releases (#178)

This commit...

1. refactors folder structure as if sublime_lib was an ordinary python library.
2. adds pyproject.toml to specify all relevant metadata
3. adds relevant scripts and actions to deploy the library as WHEEL via Github releases.

Version is bumbed to 1.6.0, but this PR doesn't change any library functionality at all.

Author: deathaxe

.coveragerc

@@ -1,12 +1,14 @@
 [flake8]
 
 ignore =
-    E731, # do not assign a lambda expression, use a def
-    W503, # line break before binary operator
+    # do not assign a lambda expression, use a def
+    E731,
+    # line break before binary operator
+    W503,
 
 exclude =
     .git,
-    st3/sublime_lib/vendor,
     .venv,
+    sublime_lib/vendor,
 
 max-line-length = 99

.flake8

@@ -7,29 +7,18 @@ on:
 
 jobs:
   deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
 
-      - name: Setup Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.x'
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
 
-      - name: Install Dependencies
-        run: |
-          python -m pip install -U pip
-          python -m pip install -U sphinx
-          python -m pip install -U sphinxcontrib.prettyspecialmethods
+      - name: Install dev dependencies
+        run: uv sync --group docs
 
       - name: Build Docs
-        run: make -C docs clean html
-        ## https://github.com/marketplace/actions/sphinx-build
-        # uses: ammaraskar/sphinx-action@0.3
-        # with:
-        #   docs-folder: docs/
-        #   repo-token: ${{ secrets.GITHUB_TOKEN }}
-        #   build-command: "make clean html"
+        run: uv run sphinx-build -M html "docs/source/" "docs/"
 
       - name: Deploy Docs
         uses: peaceiris/actions-gh-pages@v3

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install lint dependencies
+        run: uv sync --group lint
+
+      - name: Run flake8
+        run: uv run flake8 sublime_lib
+
+      - name: Run pydocstyle (allow failure)
+        run: uv run pydocstyle sublime_lib
+        continue-on-error: true

.github/workflows/gh-pages.yml

@@ -0,0 +1,26 @@
+name: Publish Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    name: Create and publish release
+    env:
+      GH_TOKEN: ${{ github.token }}
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build wheel
+        run: uv build --wheel
+
+      - name: Create release & upload wheel
+        run: gh release create --generate-notes --latest -t "$GITHUB_REF_NAME" "$GITHUB_REF_NAME" dist/*.whl

.github/workflows/lint.yml

@@ -1,7 +1,16 @@
+# caches
 __pycache__
 .mypy_cache
-docs/html/
-docs/source/modules/
-*.doctree
-*.pickle
-modules.rst
+
+# build artifacts
+dist/
+_version.py
+
+# docs build artifacts
+/docs/html/
+/docs/doctrees/
+
+# editor files
+*.sublime-project
+*.sublime-workspace
+

.github/workflows/release.yml

@@ -7,7 +7,7 @@ BUILDDIR      = .
 .PHONY: clean
 
 html:
-	sphinx-build -M html "$(SOURCEDIR)" "$(BUILDDIR)"
+	uv run sphinx-build -M html "$(SOURCEDIR)" "$(BUILDDIR)"
 
 clean:
 	rm -rf doctrees html