Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"dockerfile": "Dockerfile",
"context": "..",
"args": {
"PIXI_VERSION": "v0.41.4"
"PIXI_VERSION": "v0.48.2"
}
},
"customizations": {
Expand Down
5 changes: 2 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ updates:
groups:
dev-dependencies:
#try to group all development dependencies updates into a single pr
patterns:
- "black"
patterns:
- "check-manifest"
- "pre-commit"
- "pylint"
- "pytest"
- "pytest-cov"
- "pytest-cov"
- "hypothesis"
- "ruff"
- "coverage"
Expand Down
14 changes: 2 additions & 12 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
},
{
"label": "autoformat",
"detail": "Use ruff and black to automatically fix and format the code",
"detail": "Use ruff to automatically fix and format the code",
"type": "shell",
"command": "pixi run fmt"
"command": "pixi run format"
},
{
"label": "lint",
Expand Down Expand Up @@ -103,17 +103,7 @@
"detail": "Replaces all instances of the template project name with a new name. ",
"type": "shell",
"command": "scripts/rename_project.sh '${input:new_project_name}' '${input:new_author_name}' '${input:new_author_email}' '${input:github_username}'"
},
{
"label": "flit install",
"type": "shell",
"command": "flit install --symlink"
},
{
"label": "flit publish",
"type": "shell",
"command": "flit publish"
},
{
"label": "setup: host",
"detail": "Sets up docker, nvidia docker git-lfs and rocker which are used to clone and setup docker containers",
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## python_template

## [0.0.0]
## [0.2.0]
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ A template repo for python projects that is set up using [pixi](https://pixi.sh)
This has basic setup for

* pylint
* ruff
* black
* ruff (formatting and linting)
* pytest
* git-lfs
* basic github actions ci
Expand Down Expand Up @@ -77,7 +76,7 @@ pixi run ci

## Legacy

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.
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`.

## Troubleshooting

Expand Down
7 changes: 3 additions & 4 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ A template repo for python projects
This has basic setup for

* pylint
* ruff
* black
* ruff (formatting and linting)
* pytest
* codecov
* git-lfs
Expand All @@ -22,8 +21,8 @@ This has basic setup for
[![GitHub issues](https://img.shields.io/github/issues/blooop/python_template.svg)](https://GitHub.com/blooop/python_template/issues/)
[![GitHub pull-requests merged](https://badgen.net/github/merged-prs/blooop/python_template)](https://github.com/blooop/python_template/pulls?q=is%3Amerged)
[![GitHub release](https://img.shields.io/github/release/blooop/python_template.svg)](https://GitHub.com/blooop/python_template/releases/)
[![License](https://img.shields.io/pypi/l/bencher)](https://opensource.org/license/mit/)
[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue)](https://www.python.org/downloads/release/python-310/)
[![License](https://img.shields.io/github/license/blooop/python_template)](https://opensource.org/license/mit/)
[![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/)


To set up your project run the vscode task "pull updates from template repo" and then task "rename project template name"
1 change: 0 additions & 1 deletion scripts/rename_project.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/bin/bash

mv python_template "$1"
mv python_template.deps.yaml "$1".deps.yaml

# change project name in all files
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"
Expand Down