Skip to content

Commit a138f2e

Browse files
committed
Updated README with book overview and build instructions
1 parent 7497cb8 commit a138f2e

File tree

1 file changed

+69
-2
lines changed

1 file changed

+69
-2
lines changed

README.md

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,69 @@
1-
# python-dev-book
2-
A comprehensive guide to Python development practices from zero to production.
1+
# From Zero to Production: A Practical Python Development Pipeline
2+
3+
This repository contains the source for the book "From Zero to Production: A Practical Python Development Pipeline" - a comprehensive guide to professional Python development practices.
4+
5+
## About the Book
6+
7+
Modern Python development demands more than just writing functional code. This book presents a complete development pipeline that balances simplicity with professional practices, helping developers at all levels build maintainable, production-ready Python projects.
8+
9+
### Key Topics
10+
11+
- Setting up proper project structure and version control
12+
- Managing dependencies effectively
13+
- Using code quality tools (linting, formatting, static analysis)
14+
- Implementing testing strategies with pytest
15+
- Adding type checking to Python projects
16+
- Creating effective documentation
17+
- Implementing CI/CD pipelines
18+
- Packaging and distribution
19+
20+
The book follows a "crawl-walk-run" approach, starting with essential practices and progressively introducing more advanced techniques.
21+
22+
## Book Website
23+
24+
The rendered book is available at: https://book-repositories.github.io/python-dev-book/
25+
26+
## Related Resources
27+
28+
- **Case Study Repository**: The book includes a case study building "SimpleBot". The complete implementation can be found at [simplebot-repo-url].
29+
30+
## Building the Book Locally
31+
32+
This book is built using [Quarto](https://quarto.org/), a scientific and technical publishing system.
33+
34+
### Prerequisites
35+
36+
- Install [Quarto](https://quarto.org/docs/get-started/)
37+
- (Optional) Install [TinyTeX](https://quarto.org/docs/output-formats/pdf-basics.html) for PDF rendering
38+
39+
### Commands
40+
41+
```bash
42+
# Preview the book with live reloading
43+
quarto preview
44+
45+
# Render the book to HTML, PDF, and EPUB
46+
quarto render
47+
48+
# Publish to GitHub Pages
49+
quarto publish gh-pages
50+
```
51+
52+
## Contributing
53+
54+
While this book is primarily maintained by Michael Borck, suggestions and corrections are welcome:
55+
56+
1. File an issue describing the problem or enhancement
57+
2. For minor corrections, feel free to submit a pull request
58+
59+
## License
60+
61+
The content of this book is licensed under [license details here], which means you are free to [permissions based on your chosen license].
62+
63+
## About the Author
64+
65+
Michael Borck is [brief bio or link to personal site].
66+
67+
## Acknowledgments
68+
69+
- [Any people or organizations you'd like to thank]

0 commit comments

Comments
 (0)