Move to uv + pyproject.toml

Author: alexjweil

.github/workflows/release.yaml

@@ -15,19 +15,16 @@ jobs:
       id-token: write
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v5"
         with:
           fetch-depth: 10
-      - name: "Setup Python"
-        uses: "actions/setup-python@v4"
+      - name: "Set up Python"
+        uses: "actions/setup-python@v5"
+      - name: "Install uv"
+        uses: "astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57" # v8.0.0
         with:
-          cache: "pipenv"
-          cache-dependency-path: "sdk/Pipfile.lock"
-      - name: "Install pipenv"
-        run: "pip install pipenv wheel"
-      - name: "Install dependencies"
-        run: "rm -rf $(pipenv --venv) && pipenv install --dev"
+          version: "0.11.2"
       - name: "Build dist"
-        run: "pipenv run python setup.py sdist --format=zip"
+        run: "uv run --frozen python setup.py sdist --format=zip"
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yaml

@@ -11,31 +11,30 @@ jobs:
     runs-on: "ubuntu-22.04"
     strategy:
       matrix:
-        python_version: ["3.8", "3.10"]
+        python_version: ["3.8", "3.10", "3.12"]
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v5"
         with:
           fetch-depth: 10
-      - name: "Setup Python"
-        uses: "actions/setup-python@v4"
+      - name: "Set up Python"
+        uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.python_version }}"
-          cache: "pipenv"
-          cache-dependency-path: "Pipfile.lock"
-      - name: "Install pipenv"
-        run: "pip install pipenv wheel"
-      - name: "Install dependencies"
-        run: "rm -rf $(pipenv --venv) && pipenv --python ${{ matrix.python_version }} install --dev"
+      - name: "Install uv and set the python version"
+        uses: "astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57" # v8.0.0
+        with:
+          python-version: "${{ matrix.python-version }}"
+          version: "0.11.2"
       - name: "Run pyre"
         run: |
           set -o pipefail
-          pipenv run pyre | tee >(sed 's, ,:,' | awk -F: '{sub(" ", "", $5); print "::error file=" ENVIRON["PWD"] "/" $1 ",line=" $2 ",col=" $3 ",title=" $4 "::" $5}')
+          uv run --frozen pyre | tee >(sed 's, ,:,' | awk -F: '{sub(" ", "", $5); print "::error file=" ENVIRON["PWD"] "/" $1 ",line=" $2 ",col=" $3 ",title=" $4 "::" $5}')
       - name: "Run pytest"
-        run: "PYTHONPATH=. pipenv run pytest"
+        run: "PYTHONPATH=. uv run --frozen pytest"
       - name: "Run pylint"
-        run: "PYTHONPATH=. pipenv run pylint --jobs 0 --score n --msg-template='::{category} file={abspath},line={line},col={column},title={msg_id} {symbol}::{msg}' lightspark"
+        run: "PYTHONPATH=. uv run --frozen pylint --jobs 0 --score n --msg-template='::{category} file={abspath},line={line},col={column},title={msg_id} {symbol}::{msg}' lightspark"
       - name: "Run black"
         run: |
           set -o pipefail
-          pipenv run black --check --diff . | tee >(pipenv run ../scripts/diff2annotation.py)
+          uv run --frozen black --check --diff . | tee >(pipenv run ../scripts/diff2annotation.py)

.pyre_configuration

@@ -2,5 +2,8 @@
   "site_package_search_strategy": "pep561",
   "source_directories": [
     "."
+  ],
+  "ignore_all_errors": [
+    ".venv/**"
   ]
 }

Pipfile

@@ -6,7 +6,7 @@ The Lightspark Python SDK provides a convenient way to interact with the Lightsp
 
 To install the SDK, simply run:
 
-```bash
+```shell
 pip install lightspark
 ```
 
@@ -19,16 +19,14 @@ The documentation for this SDK (installation, usage, etc.) is available at https
 For your convenience, we included an example that shows you how to use the SDK.
 Open the file `example.py` and make sure to update the variables at the top of the page with your information, then run it using pipenv:
 
-```python
-pipenv install
-pipenv run python -m examples.example
+```shell
+uv sync
+uv run python -m examples.example
 ```
 
 There are also a few examples of webservers for demonstrating webhooks and LNURLs. These can similarly be run through Flask:
 
-```python
-pipenv install -d
-pipenv run flask --app examples.flask_lnurl_server run
+```shell
+uv sync --dev
+uv run flask --app examples.flask_lnurl_server run
 ```
-
-Note that Flask requires Python >= 3.8, so these examples will not work if running Python 3.7.

Pipfile.lock

@@ -1,3 +1,55 @@
+[project]
+name = "lightspark"
+authors = [{ name = "Lightspark Group, Inc.", email = "info@lightspark.com" }]
+dynamic = ["version"]
+description = "Python SDK for the Lightspark API"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+readme = 'README.md'
+dependencies = [
+    "cryptography>=46.0.6",
+    "lightspark-crypto-python",
+    "pyjwt",
+    "requests>=2.32.5",
+    "zstandard",
+]
+
+[project.urls]
+homepage = "https://lightspark.com"
+documentation = "https://docs.lightspark.com/lightspark-sdk/getting-started?language=Python"
+source = "https://github.com/lightsparkdev/python-sdk"
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+dev = [
+    "flask",
+    "importlib_metadata",
+    "isort==5.11.4",
+    "libcst",
+    "pylint",
+    "pyre-check",
+    "pytest",
+    "typed-ast",
+    "unidiff",
+]
+
+[tool.setuptools]
+dynamic = { version = { attr = "lightspark.version.__version__" } }
+
+[tool.setuptools.packages.find]
+include = ["lightspark*"]
+
+[tool.uv]
+package = false
+# Try to decrease the risk of supply-chain attacks like the LiteLLM attack by waiting at least a week before we
+# upgrade versions. If you need to apply an emergency update faster than this, you can run:
+#
+#   uv add $PACKAGE --exclude-newer-package $PACKAGE=false
+exclude-newer = "1 week"
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple"