Skip to content

Commit c2b0ff9

Browse files
Update README.md
Signed-off-by: Ruslan Senatorov <55090151+ruslansenatorov@users.noreply.github.com>
1 parent dcbd619 commit c2b0ff9

File tree

1 file changed

+192
-1
lines changed

1 file changed

+192
-1
lines changed

README.md

Lines changed: 192 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,192 @@
1-
# stepik https://stepik.org/a/193773
1+
# stepik: https://stepik.org/a/193773
2+
3+
# Python Open Source Standards Course
4+
## Production-Ready Python, GitHub Best Practices, Linters, Pre-Commit & Project Structure
5+
6+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
7+
[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)]()
8+
[![Code Style](https://img.shields.io/badge/code%20style-black-black)]()
9+
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen)]()
10+
11+
---
12+
13+
## 🚀 What Is This Repository?
14+
15+
**Python Open Source Standards Course** is a structured, practical course designed to teach:
16+
17+
- Python project structure best practices
18+
- GitHub repository standards
19+
- Open-source contribution workflow
20+
- Code quality tools
21+
- Linters and formatters
22+
- Pre-commit hooks configuration
23+
- CI-ready development setup
24+
25+
This course focuses on building **production-ready Python repositories** following modern open-source standards.
26+
27+
---
28+
29+
## 🔎 Keywords (for search visibility)
30+
31+
python open source standards
32+
python project structure
33+
github best practices
34+
python linting tools
35+
pre-commit hooks python
36+
python repository template
37+
production ready python
38+
python software engineering
39+
clean code python
40+
pep8 standards
41+
ruff black flake8 mypy
42+
open source workflow
43+
44+
---
45+
46+
## 📦 What You Will Learn
47+
48+
### 1️⃣ Professional Python Repository Structure
49+
50+
```
51+
52+
project/
53+
54+
├── src/
55+
├── tests/
56+
├── pyproject.toml
57+
├── README.md
58+
├── LICENSE
59+
├── CONTRIBUTING.md
60+
├── CHANGELOG.md
61+
└── .pre-commit-config.yaml
62+
63+
````
64+
65+
---
66+
67+
### 2️⃣ Python Code Quality Tools
68+
69+
We configure and explain:
70+
71+
- **Black** (code formatter)
72+
- **Ruff** (fast linter)
73+
- **Flake8**
74+
- **Mypy** (static typing)
75+
- **isort**
76+
- **Pre-commit**
77+
78+
---
79+
80+
### 3️⃣ GitHub Open Source Standards
81+
82+
You will implement:
83+
84+
- Semantic versioning
85+
- Conventional commits
86+
- Issue templates
87+
- Pull request templates
88+
- Security policy
89+
- Code of conduct
90+
- Citation file
91+
- Proper licensing
92+
93+
---
94+
95+
### 4️⃣ Pre-Commit Automation
96+
97+
We configure `.pre-commit-config.yaml` to automatically:
98+
99+
- Format code
100+
- Check lint errors
101+
- Enforce style consistency
102+
- Prevent broken commits
103+
104+
Install:
105+
106+
```bash
107+
pip install pre-commit
108+
pre-commit install
109+
````
110+
111+
---
112+
113+
## 🧠 Why This Course Matters
114+
115+
Most Python tutorials teach syntax.
116+
117+
This course teaches:
118+
119+
* How real open-source projects are structured
120+
* How to build GitHub-ready repositories
121+
* How to make your code industry-grade
122+
* How to prepare projects for research or production
123+
124+
---
125+
126+
## 🛠 Installation
127+
128+
```bash
129+
git clone https://github.com/YOUR_USERNAME/python-open-source-standards-course.git
130+
cd python-open-source-standards-course
131+
pip install -r requirements.txt
132+
```
133+
134+
---
135+
136+
## 🧪 Run Linting & Formatting
137+
138+
```bash
139+
ruff check .
140+
black .
141+
mypy .
142+
```
143+
144+
---
145+
146+
## 📈 Who Is This For?
147+
148+
* Python developers
149+
* Open-source contributors
150+
* Data scientists
151+
* Backend developers
152+
* Students preparing portfolios
153+
* Developers building research repositories
154+
155+
---
156+
157+
## 🎯 Learning Outcome
158+
159+
After completing this course, you will know how to:
160+
161+
✔ Create a clean, maintainable Python repository
162+
✔ Apply professional coding standards
163+
✔ Configure automated quality control
164+
✔ Structure open-source projects properly
165+
✔ Build production-ready Python infrastructure
166+
167+
---
168+
169+
## 📜 License
170+
171+
MIT License
172+
173+
---
174+
175+
## 🤝 Contributing
176+
177+
Contributions, improvements, and suggestions are welcome.
178+
179+
Please read `CONTRIBUTING.md`.
180+
181+
---
182+
183+
## 🔗 Related Topics
184+
185+
python open source
186+
github python standards
187+
python linting tools
188+
python precommit hooks
189+
software engineering python
190+
python clean architecture
191+
python project template
192+

0 commit comments

Comments
 (0)