things-api 0.1.0__tar.gz → 0.2.1__tar.gz

things_api-0.2.1/.github/workflows/publish.yml

@@ -0,0 +1,56 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --extra test
+
+      - name: Run tests
+        run: uv run pytest -v
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Check version consistency
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PYPROJECT_VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          if [ "$TAG_VERSION" != "$PYPROJECT_VERSION" ]; then
+            echo "::error::Tag version ($TAG_VERSION) does not match pyproject.toml version ($PYPROJECT_VERSION)"
+            exit 1
+          fi
+          echo "Version $TAG_VERSION confirmed"
+
+      - name: Build
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

{things_api-0.1.0 → things_api-0.2.1}/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 This project follows [Semantic Versioning](https://semver.org/).
 
+## [0.2.1] — 2026-04-03
+
+### Added
+
+- Published to [PyPI](https://pypi.org/project/things-api/) — install with `pip install things-api` or run with `uvx things-api`
+- GitHub Actions CI/CD pipeline with tag-driven PyPI publishing via trusted publishers (OIDC)
+
+### Fixed
+
+- Friendly error message when `THINGS_API_TOKEN` is missing instead of a Pydantic traceback
+
 ## [0.1.0] — 2026-04-03
 
 ### Added

{things_api-0.1.0 → things_api-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: things-api
-Version: 0.1.0
+Version: 0.2.1
 Summary: REST API for Things 3 — expose your tasks over HTTP
 Project-URL: Homepage, https://github.com/jaydenk/things-api
 Project-URL: Documentation, https://github.com/jaydenk/things-api/tree/main/docs
@@ -36,24 +36,33 @@ Things API reads directly from the Things SQLite database via [things.py](https:
 
 ## Getting started
 
-**Requirements:** macOS with [Things 3](https://culturedcode.com/things/) installed, Python 3.12+, and [uv](https://docs.astral.sh/uv/).
+**Requirements:** macOS with [Things 3](https://culturedcode.com/things/) installed and Python 3.12+.
 
-### 1. Clone and install
+### 1. Install
+
+Run directly with [`uvx`](https://docs.astral.sh/uv/) (no install needed):
 
 ```sh
-git clone https://github.com/jaydenk/things-api.git
-cd things-api
-uv venv
-uv pip install -e .
+uvx things-api
 ```
 
-### 2. Configure
+Or install with pip:
+
+```sh
+pip install things-api
+```
+
+Or clone the repo for development:
 
 ```sh
-cp env.example .env
+git clone https://github.com/jaydenk/things-api.git
+cd things-api
+uv venv && uv pip install -e .
 ```
 
-Open `.env` and set your API token — this is the bearer token that authenticates every request:
+### 2. Configure
+
+Create a `.env` file in the directory you'll run the server from:
 
 ```dotenv
 THINGS_API_TOKEN=choose-a-secure-random-string
@@ -72,7 +81,7 @@ See [docs/configuration.md](docs/configuration.md) for all configuration options
 ### 3. Run
 
 ```sh
-uv run things-api
+things-api
 ```
 
 The server starts on `http://localhost:5225`.

{things_api-0.1.0 → things_api-0.2.1}/README.md

@@ -6,24 +6,33 @@ Things API reads directly from the Things SQLite database via [things.py](https:
 
 ## Getting started
 
-**Requirements:** macOS with [Things 3](https://culturedcode.com/things/) installed, Python 3.12+, and [uv](https://docs.astral.sh/uv/).
+**Requirements:** macOS with [Things 3](https://culturedcode.com/things/) installed and Python 3.12+.
 
-### 1. Clone and install
+### 1. Install
+
+Run directly with [`uvx`](https://docs.astral.sh/uv/) (no install needed):
 
 ```sh
-git clone https://github.com/jaydenk/things-api.git
-cd things-api
-uv venv
-uv pip install -e .
+uvx things-api
 ```
 
-### 2. Configure
+Or install with pip:
+
+```sh
+pip install things-api
+```
+
+Or clone the repo for development:
 
 ```sh
-cp env.example .env
+git clone https://github.com/jaydenk/things-api.git
+cd things-api
+uv venv && uv pip install -e .
 ```
 
-Open `.env` and set your API token — this is the bearer token that authenticates every request:
+### 2. Configure
+
+Create a `.env` file in the directory you'll run the server from:
 
 ```dotenv
 THINGS_API_TOKEN=choose-a-secure-random-string
@@ -42,7 +51,7 @@ See [docs/configuration.md](docs/configuration.md) for all configuration options
 ### 3. Run
 
 ```sh
-uv run things-api
+things-api
 ```
 
 The server starts on `http://localhost:5225`.

{things_api-0.1.0 → things_api-0.2.1}/com.things-api.server.plist

@@ -2,7 +2,7 @@
   Things API launchd agent
 
   Install:
-    1. Edit this file — set WorkingDirectory and ProgramArguments paths
+    1. Edit this file — set WorkingDirectory and the path to uvx/uv
     2. Ensure your .env file exists in the working directory with THINGS_API_TOKEN set
     3. cp com.things-api.server.plist ~/Library/LaunchAgents/
     4. launchctl bootstrap gui/$(id -u) ~/Library/LaunchAgents/com.things-api.server.plist
@@ -18,30 +18,29 @@
 	<key>Label</key>
 	<string>com.things-api.server</string>
 
-	<!-- Working directory — the server reads .env from here -->
+	<!-- The directory containing your .env file -->
 	<key>WorkingDirectory</key>
-	<string>/path/to/things-api</string>
+	<string>/path/to/directory-with-env-file</string>
 
 	<!--
-	  Option A: Run from local source (development / pre-PyPI)
-	  Uses uv run to execute from the project directory.
-	  Replace /path/to/uv with the output of: which uv
+	  Run from PyPI via uvx (recommended).
+	  Replace /path/to/uvx with the output of: which uvx
 	-->
 	<key>ProgramArguments</key>
 	<array>
-		<string>/path/to/uv</string>
-		<string>run</string>
+		<string>/path/to/uvx</string>
 		<string>things-api</string>
 	</array>
 
 	<!--
-	  Option B: Run from PyPI (after publishing)
-	  Uncomment this block and comment out Option A above.
-	  Replace /path/to/uvx with the output of: which uvx
+	  Alternative: run from a cloned repo with uv.
+	  Uncomment this block and comment out the uvx block above.
+	  Replace /path/to/uv with the output of: which uv
 
 	<key>ProgramArguments</key>
 	<array>
-		<string>/path/to/uvx</string>
+		<string>/path/to/uv</string>
+		<string>run</string>
 		<string>things-api</string>
 	</array>
 	-->

{things_api-0.1.0 → things_api-0.2.1}/docs/deployment.md

@@ -1,6 +1,6 @@
 # Deployment
 
-These instructions assume you've already completed the [Getting Started](../README.md#getting-started) steps — the repo is cloned, dependencies are installed, and your `.env` file is configured.
+These instructions assume you've already completed the [Getting Started](../README.md#getting-started) steps and have a `.env` file configured.
 
 ## Running as a launchd service
 
@@ -8,16 +8,28 @@ A launchd agent keeps Things API running in the background. It starts automatica
 
 ### 1. Edit the plist template
 
-Open `com.things-api.server.plist` in the project root and set two paths:
+Open `com.things-api.server.plist` and set two paths:
 
-**`WorkingDirectory`** — the absolute path to your cloned `things-api` directory. This is where the server looks for your `.env` file.
+**`WorkingDirectory`** — the absolute path to the directory containing your `.env` file. If you cloned the repo, this is your `things-api` directory. If you installed via pip/uvx, this is wherever you put your `.env`.
 
 ```xml
 <key>WorkingDirectory</key>
 <string>/Users/yourname/things-api</string>
 ```
 
-**`ProgramArguments`** — the absolute path to `uv`. Find it with `which uv`.
+**`ProgramArguments`** — how to launch the server. Use full paths — launchd does not inherit your shell's `PATH`.
+
+If installed via **pip** or **uvx**:
+
+```xml
+<key>ProgramArguments</key>
+<array>
+    <string>/opt/homebrew/bin/uvx</string>
+    <string>things-api</string>
+</array>
+```
+
+If running from a **cloned repo**:
 
 ```xml
 <key>ProgramArguments</key>
@@ -28,7 +40,7 @@ Open `com.things-api.server.plist` in the project root and set two paths:
 </array>
 ```
 
-> **Note:** launchd does not inherit your shell's `PATH`, so you must use the full path to `uv`.
+Find the correct path with `which uvx` or `which uv`.
 
 ### 2. Install and load
 

{things_api-0.1.0 → things_api-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "things-api"
-version = "0.1.0"
+version = "0.2.1"
 description = "REST API for Things 3 — expose your tasks over HTTP"
 readme = "README.md"
 license = "MIT"

{things_api-0.1.0 → things_api-0.2.1}/src/things_api/app.py

@@ -89,7 +89,19 @@ def main() -> None:
         level=logging.INFO,
         format="%(asctime)s %(levelname)s %(name)s: %(message)s",
     )
-    settings = Settings()
+    try:
+        settings = Settings()
+    except Exception:
+        print(
+            "Error: THINGS_API_TOKEN is not set.\n"
+            "\n"
+            "Set it as an environment variable:\n"
+            "  THINGS_API_TOKEN=your-secret-token things-api\n"
+            "\n"
+            "Or create a .env file in the current directory:\n"
+            "  echo 'THINGS_API_TOKEN=your-secret-token' > .env"
+        )
+        raise SystemExit(1)
     app = create_app(settings)
     uvicorn.run(
         app,

{things_api-0.1.0 → things_api-0.2.1}/uv.lock

@@ -389,7 +389,7 @@ wheels = [
 
 [[package]]
 name = "things-api"
-version = "0.1.0"
+version = "0.2.1"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi" },