Skip to content

Commit e49961e

Browse files
committed
docs: usage
1 parent fb6af8a commit e49961e

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,40 @@ But it is often tiresome to manually setup pyprojects when most of it is boilerp
1414
* **Testing Ready:** Ships with `pytest` and a dummy test file to ensure your CI/CD passes on day one.
1515
* **Distribution Ready:** Includes `build`, `twine`, and `pyinstaller` in dev dependencies so you are ready to publish to PyPI or build standalone executables.
1616

17+
## Usage
18+
19+
You can use `pyplatez` to instantly scaffold a batteries-included Python project or also you can use this directly in GitHub as template repository.
20+
21+
### Installation
22+
Install the package globally using `pip` or `uv`:
23+
24+
```bash
25+
pip install pyplatez
26+
# or use uv (Recommended)
27+
uv tool install pyplatez
28+
```
29+
30+
### To create a new project
31+
32+
```bash
33+
pyplatez init pyproj
34+
```
35+
36+
By default, this will create a new directory in your current folder. If you want to specify a custom path, use the `--path` flag:
37+
38+
```bash
39+
pyplatez init pyproj --path ~/Projects/pyproj
40+
```
41+
42+
Navigate to the folder & sync all dependencies:
43+
44+
```bash
45+
cd pyproj
46+
uv sync
47+
```
48+
49+
& Start Comding!
50+
1751
## Directory Structure
1852

1953
Here is how the boilerplate is organized:
@@ -68,7 +102,7 @@ Even Contributing Guidelines, Code-Of-Conduct & Issue templates are filled with
68102

69103
## Future
70104

71-
Planning to publish this on PyPi to generate a `batteries-included` python framework like how uv init does it.
105+
Planning to make this customizable for different purposes for lightning fast iteration.
72106

73107
## License
74108

0 commit comments

Comments
 (0)