Skip to content

Commit ca9bd8f

Browse files
authored
Merge pull request #99 from blooop/claude/update-readme-cleanup-011CV3tezqW7h6y6TN1Utonb
Update README and remove outdated information
2 parents f67a4c9 + f28bb03 commit ca9bd8f

File tree

7 files changed

+11
-25
lines changed

7 files changed

+11
-25
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"dockerfile": "Dockerfile",
55
"context": "..",
66
"args": {
7-
"PIXI_VERSION": "v0.41.4"
7+
"PIXI_VERSION": "v0.48.2"
88
}
99
},
1010
"customizations": {

.github/dependabot.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,12 @@ updates:
1212
groups:
1313
dev-dependencies:
1414
#try to group all development dependencies updates into a single pr
15-
patterns:
16-
- "black"
15+
patterns:
1716
- "check-manifest"
1817
- "pre-commit"
1918
- "pylint"
2019
- "pytest"
21-
- "pytest-cov"
20+
- "pytest-cov"
2221
- "hypothesis"
2322
- "ruff"
2423
- "coverage"

.vscode/tasks.json

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
},
2424
{
2525
"label": "autoformat",
26-
"detail": "Use ruff and black to automatically fix and format the code",
26+
"detail": "Use ruff to automatically fix and format the code",
2727
"type": "shell",
28-
"command": "pixi run fmt"
28+
"command": "pixi run format"
2929
},
3030
{
3131
"label": "lint",
@@ -103,17 +103,7 @@
103103
"detail": "Replaces all instances of the template project name with a new name. ",
104104
"type": "shell",
105105
"command": "scripts/rename_project.sh '${input:new_project_name}' '${input:new_author_name}' '${input:new_author_email}' '${input:github_username}'"
106-
},
107-
{
108-
"label": "flit install",
109-
"type": "shell",
110-
"command": "flit install --symlink"
111106
},
112-
{
113-
"label": "flit publish",
114-
"type": "shell",
115-
"command": "flit publish"
116-
},
117107
{
118108
"label": "setup: host",
119109
"detail": "Sets up docker, nvidia docker git-lfs and rocker which are used to clone and setup docker containers",

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
## python_template
44

5-
## [0.0.0]
5+
## [0.2.0]

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ A template repo for python projects that is set up using [pixi](https://pixi.sh)
44
This has basic setup for
55

66
* pylint
7-
* ruff
8-
* black
7+
* ruff (formatting and linting)
98
* pytest
109
* git-lfs
1110
* basic github actions ci
@@ -77,7 +76,7 @@ pixi run ci
7776

7877
## Legacy
7978

80-
If you don't want to install rocker on your system but want to use vscode, you can run the `scripts/launch_vscode.sh` script to build and connect to a docker container. It will install rocker in a venv. The docker container is dynamically generated using [rocker](https://github.com/osrf/rocker) and [deps rocker](https://github.com/blooop/deps_rocker). [deps rocker](https://github.com/blooop/deps_rocker) looks at the python_template.deps.yaml file to install any required apt, pip or shell scripts and launches a container that vscode attaches to.
79+
If you don't want to install rocker on your system but want to use vscode, you can run the `scripts/launch_vscode.sh` script to build and connect to a docker container. It will install rocker in a venv. The docker container is dynamically generated using [rocker](https://github.com/osrf/rocker) and the configuration in `rockerc.yaml`.
8180

8281
## Troubleshooting
8382

docs/intro.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ A template repo for python projects
66
This has basic setup for
77

88
* pylint
9-
* ruff
10-
* black
9+
* ruff (formatting and linting)
1110
* pytest
1211
* codecov
1312
* git-lfs
@@ -22,8 +21,8 @@ This has basic setup for
2221
[![GitHub issues](https://img.shields.io/github/issues/blooop/python_template.svg)](https://GitHub.com/blooop/python_template/issues/)
2322
[![GitHub pull-requests merged](https://badgen.net/github/merged-prs/blooop/python_template)](https://github.com/blooop/python_template/pulls?q=is%3Amerged)
2423
[![GitHub release](https://img.shields.io/github/release/blooop/python_template.svg)](https://GitHub.com/blooop/python_template/releases/)
25-
[![License](https://img.shields.io/pypi/l/bencher)](https://opensource.org/license/mit/)
26-
[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue)](https://www.python.org/downloads/release/python-310/)
24+
[![License](https://img.shields.io/github/license/blooop/python_template)](https://opensource.org/license/mit/)
25+
[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
2726

2827

2928
To set up your project run the vscode task "pull updates from template repo" and then task "rename project template name"

scripts/rename_project.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
#!/bin/bash
22

33
mv python_template "$1"
4-
mv python_template.deps.yaml "$1".deps.yaml
54

65
# change project name in all files
76
find . \( -type d -name .git -prune \) -o \( -type f -not -name 'tasks.json' -not -name 'update_from_template.sh' \) -print0 | xargs -0 sed -i "s/python_template/$1/g"

0 commit comments

Comments
 (0)