Skip to content

Commit fe5094f

Browse files
committed
config: Adding README.md and LICENSE
1 parent e945074 commit fe5094f

File tree

5 files changed

+138
-4
lines changed

5 files changed

+138
-4
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Raphael-GC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1-
# nlw-python
2-
A Python project using Flask.
1+
<h1 align="center">
2+
<img
3+
alt="Python-barcode"
4+
title="Python-barcode Logo"
5+
src="./assets/logo.svg"
6+
width="300px" />
7+
</h1>
8+
9+
<h4 align="center">A Python project using Flask for generating barcodes. This project belongs to Rocketseat's event called NLW-Experts.</h4>
10+
11+
<center> ![Progress](https://progress-bar.dev/33/?title=done)
12+
13+
## ⚙️Techs:
14+
- [Virtualenv](https://pypi.org/project/virtualenv/)
15+
- [Pylint](https://pypi.org/project/pylint/)
16+
- [Pre-commit](https://pre-commit.com/)
17+
- [Flask](https://pypi.org/project/Flask/)
18+
- [Python-barcode](https://pypi.org/project/python-barcode/)
19+
- [Pillow](https://pypi.org/project/pillow/)
20+
21+
## 🔗Useful links:
22+
- [Notion](https://efficient-sloth-d85.notion.site/NLW-14-Expert-9e11ff472de64b08a5f9e277a20c3ecc)
23+
- [Event Website](https://www.rocketseat.com.br/eventos/nlw)
24+
- [Wallpapers](https://drive.google.com/drive/folders/1bdX5SIrw6MBBqBkZgryc4H_omPQhuPx-)
25+
26+
## 📋Notes:
27+
<details>
28+
29+
<summary>⏰Day-1</summary>
30+
- Adding Pylint to project
31+
- Adding pre-commit to project
32+
- Adding server base params, including route and feature for generating barcode
33+
- Adding and update the requirements
34+
- Adding README.md and LICENSE
35+
36+
**Pylint and naming conventions**:
37+
```py
38+
def my_func(): # snake_case -> Functions, Variables, Methods
39+
print('Ola')
40+
41+
def myFunc(): # camelCase -> It's not the usual default.
42+
print('Ola2')
43+
44+
class MyFunc: # PascalCase -> Classes
45+
46+
SCREAMING_SNAKE_CASE: # -> Const
47+
48+
```
49+
----
50+
**Requirements**: <br>
51+
When we want to keep a record of installed dependencies and their versions, we use this command in the terminal.
52+
```sh
53+
.venv\Scripts\pip3 freeze > requirements.txt
54+
```
55+
</details>
56+
57+
<details>
58+
59+
<summary>⏰Day-2</summary>
60+
61+
</details>
62+
63+
<details>
64+
65+
<summary>⏰Day-3</summary>
66+
67+
</details>

assets/favicon.ico.ico

97.3 KB
Binary file not shown.

assets/logo.svg.svg

Lines changed: 50 additions & 0 deletions
Loading

example.py

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)