Merge pull request #4 from falkben/rem_setup_py

switch to pyproject.toml

.github/workflows/test.yml

@@ -14,10 +14,11 @@ jobs:
         with:
           python-version: "3.10"
           cache: "pip"
+          cache-dependency-path: "**/dev-requirements.txt"
 
       - name: install
         run: |
-          pip install . -r requirements.txt
+          pip install . -r dev-requirements.txt
 
       - name: pytest
         run: pytest

README.md

@@ -47,4 +47,17 @@ With this hook installed, when you commit, if a Jira issue is found in your bran
 
 ## Developer Notes
 
-todo
+### Install for local dev
+
+Create virtual environment then install:
+
+```bash
+pip install -r dev-requirements.txt
+pip install -e ".[dev]"
+```
+
+## Create dev dependency lock file
+
+```bash
+pip-compile --extra dev -o dev-requirements.txt pyproject.toml
+```

requirements.txt → dev-requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
-#    pip-compile
+#    pip-compile --extra=dev --output-file=dev-requirements.txt pyproject.toml
 #
 attrs==22.1.0
     # via pytest
@@ -17,6 +17,6 @@ py==1.11.0
 pyparsing==3.0.9
     # via packaging
 pytest==7.1.3
-    # via -r requirements.in
+    # via prepend_jira_issue (pyproject.toml)
 tomli==2.0.1
     # via pytest

pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "prepend_jira_issue"
+version = "0.0.1"
+authors = [
+  { name="Benjamin Falk", email="[email protected]" },
+]
+description = "A small example package"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/falkben/pre-commit-prepend-jira-issue"
+
+[project.scripts]
+prepend_jira_issue = "prepend_jira_issue:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+]