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 .github/rulesets/branches/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "main",
"target": "branch",
"source_type": "Repository",
"source": "EED-Solutions/eed_package_template",
"source": "EED-Solutions/eed_docker_python_uv",
"enforcement": "active",
"conditions": {
"ref_name": {
Expand Down
4 changes: 2 additions & 2 deletions .github/rulesets/tags/semantic versioning.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "semantic versioning",
"target": "tag",
"source_type": "Repository",
"source": "EED-Solutions/eed_package_template",
"source": "EED-Solutions/eed_docker_python_uv",
"enforcement": "active",
"conditions": {
"ref_name": {
Expand Down Expand Up @@ -56,4 +56,4 @@
}
],
"bypass_actors": []
}
}
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
# eed_package_template

## Creating a New Repository from This Template
## Description

1. In the EED-Solutions organization, create a new repository using this template and assign it a new name, such as `eed_my_new_package`.
2. Create a new branch (e.g., `repo_configuration`).
3. Delete the `uv.lock` file.
4. Update `project.toml` by renaming `eed-package-template` to your new package name (e.g., `eed-my-new-package`).
5. Set up a virtual environment using `uv`.
6. Install pre-commit hooks.
7. Add a note indicating the commit ID from which this repository was created, for example:
- created from this template: <https://github.com/EED-Solutions/eed_package_template/tree/f94454015a1b237a0699bf26f8edcdb3c861cc95>
```
- created from this template: https://github.com/EED-Solutions/eed_package_template/releases/tag/0.1.0
```
8. Rename the directory `src/eed_package_template` to match your new package name (e.g., `src/eed_my_new_package`).
9. Use VS Code's find and replace feature to update all instances of `eed_package_template` with your new package name.
10. Commit all changes, create a pull request, and ensure all CI pipelines pass.
11. Update repository settings as needed (e.g., import branch/tag rulesets, general settings). For more information, see [this guide](https://eed-solutions.atlassian.net/wiki/x/BIA8Mw) (private access). Rulesets are documented under ``.github\rulesets`` and can be imported.
12. Merge the pull request and create the initial release (e.g., `0.1.0`).

## Github actions

Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "eed-package-template"
version = "0.2.0"
description = "Add your description here"
name = "eed-docker-python-uv"
version = "0.1.0"
description = "Manages the Python environment for EED-Solutions Docker images using uv."
readme = "README.md"
authors = [
{ name = "EED85", email = "eric.brahmann@eed-solutions.de" }
Expand All @@ -24,7 +24,7 @@ dev = [
]

[project.scripts]
hello_world = "eed_package_template.hello_world:hello_world"
hello_world = "eed_docker_python_uv.hello_world:hello_world"

[tool.ruff]
# Set the maximum line length to 79.
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions tests/test_hello_world.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from eed_package_template import hello_world
from eed_docker_python_uv import hello_world


def test_hello_world() -> None:
Expand All @@ -12,6 +12,6 @@ def test_hello_world() -> None:
assert "Hello from" in result, (
"Greeting message should start with 'Hello from'"
)
assert "eed_package_template" in result, (
assert "eed_docker_python_uv" in result, (
"Greeting message should include 'eed-package-template'"
)
110 changes: 66 additions & 44 deletions uv.lock

Large diffs are not rendered by default.

Loading