Skip to content

Commit 9517afd

Browse files
nullhacknullhack
authored
Update README.md
1 parent 31c64a9 commit 9517afd

File tree

1 file changed

+186
-0
lines changed

1 file changed

+186
-0
lines changed

‎README.md‎

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
<div id="top"></div>
2+
3+
<!-- PROJECT SHIELDS -->
4+
<!--
5+
*** I'm using markdown "reference style" links for readability.
6+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
7+
*** See the bottom of this document for the declaration of the reference variables
8+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
9+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
10+
-->
11+
[![Contributors][contributors-shield]][contributors-url]
12+
[![Forks][forks-shield]][forks-url]
13+
[![Stargazers][stars-shield]][stars-url]
14+
[![Issues][issues-shield]][issues-url]
15+
[![MIT License][license-shield]][license-url]
16+
17+
18+
19+
<!-- PROJECT LOGO -->
20+
<br />
21+
<div align="center">
22+
23+
<h3 align="center"> cookiecutter-python-base-project</h3>
24+
25+
<p align="center">
26+
Cookiecutter for Python template with some awesome tools to quickstart any Python project.
27+
<br />
28+
<a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/nullhack/cookiecutter-python-base-project/main/docs/api/cookiecutter-python-base-project/index.html"><strong>Explore the docs »</strong></a>
29+
<br />
30+
<br />
31+
<a href="https://github.com/nullhack/cookiecutter-python-base-project/issues">Report Bug</a>
32+
·
33+
<a href="https://github.com/nullhack/cookiecutter-python-base-project/issues">Request Feature</a>
34+
</p>
35+
</div>
36+
37+
38+
39+
<!-- TABLE OF CONTENTS -->
40+
<details>
41+
<summary>Table of Contents</summary>
42+
<ol>
43+
<li>
44+
<a href="#about-the-project">About The Project</a>
45+
<ul>
46+
<li><a href="#uml-diagrams">UML Diagrams</a></li>
47+
</ul>
48+
</li>
49+
<li>
50+
<a href="#getting-started">Getting Started</a>
51+
<ul>
52+
<li><a href="#prerequisites">Prerequisites</a></li>
53+
<li><a href="#installation">Installation</a></li>
54+
</ul>
55+
</li>
56+
<li><a href="#roadmap">Roadmap</a></li>
57+
<li><a href="#contributing">Contributing</a></li>
58+
<li><a href="#license">License</a></li>
59+
<li><a href="#contact">Contact</a></li>
60+
<li><a href="#acknowledgments">Acknowledgments</a></li>
61+
</ol>
62+
</details>
63+
64+
65+
66+
<!-- ABOUT THE PROJECT -->
67+
## About The Project
68+
69+
Python template with some awesome tools to quickstart any Python project.
70+
It includes automatic generation of API documentation, tests using PyTest, code coverage,
71+
Flake8 linting to enforce standardized Python coding, automatic UML diagrams generation using PyReverse,
72+
virtual environments using Poetry, workflow automation using Nox,
73+
code formating using black and a standard Dockerfile to kickstart your project using the power of Docker containers and much more.
74+
75+
All you need to do is install [Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/usage.html)
76+
77+
---
78+
79+
<!-- GETTING STARTED -->
80+
## Getting Started
81+
82+
### [Live Example](https://github.com/nullhack/python-base-project)
83+
84+
To get a local copy up and running follow these simple steps.
85+
86+
### Prerequisites
87+
88+
This Project depends on the following projects.
89+
* cookiecutter
90+
```sh
91+
pip install --user --upgrade cookiecutter
92+
```
93+
94+
### Installation
95+
96+
1. Replicate the template locally
97+
```sh
98+
cookiecutter https://github.com/nullhack/cookiecutter-python-base-project
99+
# move into your newly created project folder
100+
```
101+
2. Install nox
102+
```sh
103+
pip install --user --upgrade nox
104+
```
105+
3. Let nox do it's magic
106+
```sh
107+
nox
108+
```
109+
110+
<p align="right">(<a href="#top">back to top</a>)</p>
111+
112+
113+
<!-- ROADMAP -->
114+
## Roadmap
115+
116+
- [ ] Improve documentation
117+
118+
See the [open issues](https://github.com/nullhack/cookiecutter-python-base-project/issues) for a full list of proposed features (and known issues).
119+
120+
<p align="right">(<a href="#top">back to top</a>)</p>
121+
122+
123+
<!-- CONTRIBUTING -->
124+
## Contributing
125+
126+
Any contributions you make are **greatly appreciated**.
127+
128+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
129+
Don't forget to give the project a star! Thanks again!
130+
131+
1. Fork the Project
132+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
133+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
134+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
135+
5. Open a Pull Request
136+
137+
<p align="right">(<a href="#top">back to top</a>)</p>
138+
139+
140+
<!-- LICENSE -->
141+
## License
142+
143+
Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/nullhack/cookiecutter-python-base-project/blob/master/LICENSE.txt) for more information.
144+
145+
<p align="right">(<a href="#top">back to top</a>)</p>
146+
147+
148+
<!-- CONTACT -->
149+
## Contact
150+
151+
Eric Lopes - [@nullhack](https://github.com/nullhack)
152+
153+
Project Link: [https://github.com/nullhack/cookiecutter-python-base-project/](https://github.com/nullhack/cookiecutter-python-base-project/)
154+
155+
<p align="right">(<a href="#top">back to top</a>)</p>
156+
157+
158+
<!-- ACKNOWLEDGMENTS -->
159+
## Acknowledgments
160+
161+
Some great references to start from
162+
163+
* [Choose an Open Source License](https://choosealicense.com)
164+
165+
References and sources of inspiration
166+
167+
* [Hypermodern Python](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/)
168+
* [Best practices for Python projects in 2021](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/)
169+
* [5 Pytest Best Practices for Writing Great Python Tests](https://www.nerdwallet.com/blog/engineering/5-pytest-best-practices/)
170+
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
171+
172+
<p align="right">(<a href="#top">back to top</a>)</p>
173+
174+
175+
<!-- MARKDOWN LINKS & IMAGES -->
176+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
177+
[contributors-shield]: https://img.shields.io/github/contributors/nullhack/cookiecutter-python-base-project.svg?style=for-the-badge
178+
[contributors-url]: https://github.com/nullhack/cookiecutter-python-base-project/graphs/contributors
179+
[forks-shield]: https://img.shields.io/github/forks/nullhack/cookiecutter-python-base-project.svg?style=for-the-badge
180+
[forks-url]: https://github.com/nullhack/cookiecutter-python-base-project/network/members
181+
[stars-shield]: https://img.shields.io/github/stars/nullhack/cookiecutter-python-base-project.svg?style=for-the-badge
182+
[stars-url]: https://github.com/nullhack/cookiecutter-python-base-project/stargazers
183+
[issues-shield]: https://img.shields.io/github/issues/nullhack/cookiecutter-python-base-project.svg?style=for-the-badge
184+
[issues-url]: https://github.com/nullhack/cookiecutter-python-base-project/issues
185+
[license-shield]: https://img.shields.io/badge/license-MIT-green?style=for-the-badge
186+
[license-url]: https://github.com/nullhack/cookiecutter-python-base-project/blob/master/LICENSE.txt

0 commit comments

Comments
 (0)