Skip to content

Commit c96457e

Browse files
committed
clean up Readme
1 parent 5c03eee commit c96457e

File tree

1 file changed

+34
-31
lines changed

1 file changed

+34
-31
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,82 +19,85 @@
1919
</a>
2020
</p>
2121

22-
2322
<p align="center">
2423
<a href="https://github.com/codespaces/badge.svg)](https://codespaces.new/aniketmaurya/python-project-template?template=false">
2524
<img src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces">
2625
</a>
2726
</p>
2827

28+
# Features
2929

30+
- πŸš€ Modern Python project structure
31+
- πŸ“¦ Pre-configured [pyproject.toml](pyproject.toml)
32+
- πŸ€– ML server template with [LitServe](https://github.com/Lightning-AI/LitServe)
33+
- πŸ§ͺ Testing setup with [pytest](https://docs.pytest.org/en/latest/)
34+
- πŸ‘· CI/CD with [GitHub Actions](https://github.com/aniketmaurya/python-project-template/blob/main/.github/workflows)
35+
- πŸ“ Auto-generated documentation
36+
- 🎯 Type hints and static type checking
37+
- πŸ” Code formatting with ruff and isort
38+
- πŸ› Linting with ruff
39+
40+
# Project Structure
41+
42+
```
43+
python-project-template/
44+
β”œβ”€β”€ .github/
45+
β”‚ └── workflows/ # GitHub Actions workflows
46+
β”œβ”€β”€ docs/ # Documentation
47+
β”œβ”€β”€ src/ # Source code
48+
β”‚ └── python_project_template/
49+
β”œβ”€β”€ tests/ # Test files
50+
β”œβ”€β”€ .gitignore
51+
β”œβ”€β”€ LICENSE
52+
β”œβ”€β”€ README.md
53+
β”œβ”€β”€ pyproject.toml # Project metadata and dependencies
54+
└── setup.py # Package installation
55+
```
3056

3157
# Installation
3258

3359
## From Source
60+
3461
```bash
3562
git clone https://github.com/aniketmaurya/python-project-template.git
3663
cd python-project-template
3764
pip install .
3865
```
3966

4067
## Development Installation
68+
4169
```bash
4270
git clone https://github.com/aniketmaurya/python-project-template.git
4371
cd python-project-template
4472
pip install -e ".[dev]"
4573
```
4674

47-
# Usage
75+
## Usage
4876

4977
```python
5078
from python_project_template import do_something_awesome
5179

5280
print(do_something_awesome())
5381
```
5482

55-
# Features
56-
57-
- πŸš€ Modern Python project structure
58-
- πŸ“¦ Pre-configured setup.py and pyproject.toml
59-
- πŸ§ͺ Testing setup with pytest
60-
- πŸ‘· CI/CD with GitHub Actions
61-
- πŸ“ Auto-generated documentation
62-
- 🎯 Type hints and static type checking
63-
- πŸ” Code formatting with black and isort
64-
- πŸ› Linting with flake8
65-
66-
# Project Structure
67-
68-
```
69-
python-project-template/
70-
β”œβ”€β”€ .github/
71-
β”‚ └── workflows/ # GitHub Actions workflows
72-
β”œβ”€β”€ docs/ # Documentation
73-
β”œβ”€β”€ src/ # Source code
74-
β”‚ └── python_project_template/
75-
β”œβ”€β”€ tests/ # Test files
76-
β”œβ”€β”€ .gitignore
77-
β”œβ”€β”€ LICENSE
78-
β”œβ”€β”€ README.md
79-
β”œβ”€β”€ pyproject.toml # Project metadata and dependencies
80-
└── setup.py # Package installation
81-
```
82-
8383
# Development
8484

8585
1. Clone the repository
86+
8687
```bash
8788
git clone https://github.com/aniketmaurya/python-project-template.git
8889
cd python-project-template
8990
```
9091

9192
2. Create a virtual environment
93+
9294
```bash
9395
python -m venv venv
9496
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
9597
```
9698

9799
3. Install development dependencies
100+
98101
```bash
99102
pip install -e ".[dev]"
100103
```
@@ -105,7 +108,7 @@ pip install -e ".[dev]"
105108
pytest tests/
106109
```
107110

108-
## Contributing
111+
# Contributing
109112

110113
Contributions are always welcome! Here's how you can help:
111114

0 commit comments

Comments
Β (0)