PYPI readiness

Author: rembish

.github/workflows/ci.yml

@@ -17,9 +17,6 @@ jobs:
         with:
           python-version: "3.12"
 
-      - name: Install cfb (not yet on PyPI)
-        run: pip install git+https://github.com/rembish/cfb.git
-
       - name: Install dependencies
         run: pip install -e ".[dev]"
 
@@ -46,9 +43,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install cfb (not yet on PyPI)
-        run: pip install git+https://github.com/rembish/cfb.git
-
       - name: Install dependencies
         run: pip install -e ".[dev]"
 

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

Makefile

@@ -2,7 +2,7 @@ VENV   := .venv
 PYTHON := $(VENV)/bin/python
 PIP    := $(VENV)/bin/pip
 
-.PHONY: help install lint format typecheck test tox pre-commit clean
+.PHONY: help install lint format typecheck test tox pre-commit build publish clean
 
 help:
 	@echo "Usage: make <target>"
@@ -14,12 +14,13 @@ help:
 	@echo "  test        run pytest with coverage"
 	@echo "  tox         run tests across py38, py310, py312"
 	@echo "  pre-commit  install pre-commit hooks"
+	@echo "  build       build sdist and wheel"
+	@echo "  publish     upload to PyPI with twine"
 	@echo "  clean       remove build artifacts and caches"
 
 $(VENV)/bin/activate: pyproject.toml
 	python3 -m venv $(VENV)
 	$(PIP) install --upgrade pip
-	$(PIP) install -e "../cfb"
 	$(PIP) install -e ".[dev]"
 	touch $(VENV)/bin/activate
 
@@ -41,6 +42,14 @@ test: $(VENV)/bin/activate
 tox: $(VENV)/bin/activate
 	$(VENV)/bin/tox
 
+build: $(VENV)/bin/activate
+	$(PIP) install build
+	$(PYTHON) -m build
+
+publish: build
+	$(PIP) install twine
+	$(VENV)/bin/twine upload dist/*
+
 pre-commit: $(VENV)/bin/activate
 	$(VENV)/bin/pre-commit install
 

README.md

@@ -29,9 +29,6 @@ make pre-commit   # install pre-commit hooks
 make clean        # remove build artifacts and caches
 ```
 
-> **Note:** `cfb` is not yet on PyPI. The Makefile installs it from `../cfb`.
-> For CI, it is installed from GitHub.
-
 ## License
 
 BSD 2-Clause — see [LICENSE](LICENSE).

pyproject.toml

@@ -7,13 +7,12 @@ name = "miette"
 version = "2.0.2"
 description = "Miette is a light-weight Microsoft Office documents reader"
 readme = "README.md"
-license = { text = "BSD-2-Clause" }
+license = "BSD-2-Clause"
 authors = [{ name = "Alex Rembish", email = "alex@rembish.org" }]
 requires-python = ">=3.8"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: BSD License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
@@ -25,10 +24,13 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Text Processing",
 ]
-dependencies = ["cfb", "typing_extensions"]
+dependencies = ["cfb>=0.9.3", "typing_extensions"]
 
 [project.urls]
 Homepage = "https://github.com/rembish/Miette"
+Repository = "https://github.com/rembish/Miette"
+Changelog = "https://github.com/rembish/Miette/blob/master/CHANGELOG.md"
+Issues = "https://github.com/rembish/Miette/issues"
 
 [project.optional-dependencies]
 dev = [