Skip to content

Commit 24408bf

Browse files
committed
fixed readme
1 parent 025eb61 commit 24408bf

File tree

1 file changed

+9
-38
lines changed

1 file changed

+9
-38
lines changed

README.md

+9-38
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,17 @@
66
[![Commit activity](https://img.shields.io/github/commit-activity/m/NoxelS/python-base-api)](https://img.shields.io/github/commit-activity/m/NoxelS/python-base-api)
77
[![License](https://img.shields.io/github/license/NoxelS/python-base-api)](https://img.shields.io/github/license/NoxelS/python-base-api)
88

9-
This is a template repository for Python projects that use uv for their dependency management.
9+
This is a template repository for Python projects that use uv for their dependency management, fastapi as API server and some CI/CD pipelines
10+
for automated testing and code coverage.
1011

1112
- **Github repository**: <https://github.com/NoxelS/python-base-api/>
12-
- **Documentation** <https://NoxelS.github.io/python-base-api/>
1313

1414
## Getting started with your project
1515

16-
### 1. Create a New Repository
16+
### 1. Using This Template
1717

18-
First, create a repository on GitHub with the same name as this project, and then run the following commands:
18+
Cick on "Use this template" to create a repository based on the python base api repository.
1919

20-
```bash
21-
git init -b main
22-
git add .
23-
git commit -m "init commit"
24-
git remote add origin [email protected]:NoxelS/python-base-api.git
25-
git push -u origin main
26-
```
2720

2821
### 2. Set Up Your Development Environment
2922

@@ -33,7 +26,11 @@ Then, install the environment and the pre-commit hooks with
3326
make install
3427
```
3528

36-
This will also generate your `uv.lock` file
29+
This will also generate your `uv.lock` file.
30+
31+
You are now ready to start development on your project!
32+
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
33+
3734

3835
### 3. Run the pre-commit hooks
3936

@@ -43,32 +40,6 @@ Initially, the CI/CD pipeline might be failing due to formatting issues. To reso
4340
uv run pre-commit run -a
4441
```
4542

46-
### 4. Commit the changes
47-
48-
Lastly, commit the changes made by the two steps above to your repository.
49-
50-
```bash
51-
git add .
52-
git commit -m 'Fix formatting issues'
53-
git push origin main
54-
```
55-
56-
You are now ready to start development on your project!
57-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
58-
59-
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
60-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
61-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
62-
63-
## Releasing a new version
64-
65-
- Create an API Token on [PyPI](https://pypi.org/).
66-
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/NoxelS/python-base-api/settings/secrets/actions/new).
67-
- Create a [new release](https://github.com/NoxelS/python-base-api/releases/new) on Github.
68-
- Create a new tag in the form `*.*.*`.
69-
70-
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
71-
7243
---
7344

7445
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

0 commit comments

Comments
 (0)