Skip to content

Commit a02b2b7

Browse files
committed
Update dependencies and add uv script section
1 parent 702b3ac commit a02b2b7

File tree

5 files changed

+106
-102
lines changed

5 files changed

+106
-102
lines changed

.github/pull-request-template.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,6 @@ YES | NO
1515
### What are the relevant tickets?
1616
- Include links to Jira Software and/or Jira Service Management tickets here.
1717

18-
### Developer
19-
- [ ] All new ENV is documented in README
20-
- [ ] All new ENV has been added to staging and production environments
21-
- [ ] All related Jira tickets are linked in commit message(s)
22-
- [ ] Stakeholder approval has been confirmed (or is not needed)
23-
24-
### Code Reviewer(s)
25-
- [ ] The commit message is clear and follows our guidelines (not just this PR message)
26-
- [ ] There are appropriate tests covering any new functionality
27-
- [ ] The provided documentation is sufficient for understanding any new functionality introduced
28-
- [ ] Any manual tests have been performed **or** provided examples verified
29-
- [ ] New dependencies are appropriate or there were no changes
18+
### Code review
19+
* Code review best practices are documented [here](https://mitlibraries.github.io/guides/collaboration/code_review.html) and you are encouraged to have a constructive dialogue with your reviewers about their preferences and expectations.
3020

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,9 @@ black-apply: # Apply changes with 'black'
6565

6666
ruff-apply: # Resolve 'fixable errors' with 'ruff'
6767
uv run ruff check --fix .
68+
69+
##############################
70+
# CLI convenience commands
71+
##############################
72+
my-app: # CLI without any arguments, utilizing uv script entrypoint
73+
uv run my-app

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Description of the app
3131
- To update dependencies: `make update`
3232
- To run unit tests: `make test`
3333
- To lint the repo: `make lint`
34-
- To run the app: `uv run my_app --help`
34+
- To run the app: `uv run my-app --help` (Note the hyphen `-` vs underscore `_` that matches the `project.scripts` in `pyproject.toml`)
3535

3636
## Environment Variables
3737

pyproject.toml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# https://mitlibraries.atlassian.net/wiki/spaces/IN/pages/3432415247/Python+Project+Linters#Template-for-pyproject.toml
44

55
[project]
6-
name = "python-lambda-template"
6+
name = "python-cli-template"
77
version = "2.0.0"
88
requires-python = ">=3.13"
99

@@ -83,3 +83,10 @@ max-doc-length = 90
8383

8484
[tool.ruff.lint.pydocstyle]
8585
convention = "google"
86+
87+
[project.scripts]
88+
my-app = "my_app.cli:main"
89+
90+
[build-system]
91+
requires = ["setuptools>=61"]
92+
build-backend = "setuptools.build_meta"

0 commit comments

Comments
 (0)