Skip to content

Commit 1a9efc6

Browse files
caio-pavesicaio-pavesi
authored
Merge pull request #1 from caio-pavesi:dev-v0
feat: Version 0
2 parents 9a7490d + a3fc7e1 commit 1a9efc6

15 files changed

Lines changed: 203 additions & 1 deletion

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "pip" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"

‎.vscode/extensions.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"recommendations": [
3+
"github.copilot",
4+
"ms-python.python",
5+
"ms-python.pylint",
6+
"ms-python.debugpy",
7+
"ms-python.autopep8",
8+
"ms-toolsai.jupyter",
9+
"qwtel.sqlite-viewer",
10+
"hediet.vscode-drawio",
11+
"njpwerner.autodocstring",
12+
"ms-toolsai.datawrangler",
13+
"ms-python.vscode-pylance",
14+
"aaron-bond.better-comments",
15+
"chdsbd.python-inline-sql-syntax",
16+
"visualstudioexptteam.vscodeintellicode"
17+
]
18+
}

‎.vscode/launch.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Python Debugger: Current File",
6+
"type": "debugpy",
7+
"request": "launch",
8+
"program": "${file}",
9+
"console": "integratedTerminal"
10+
}
11+
]
12+
}

‎.vscode/settings.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"python.testing.pytestEnabled": true,
3+
"python.testing.unittestEnabled": false,
4+
"pylint.args": [
5+
"--disable=C0301",
6+
"--disable=W0719",
7+
"--disable=W0718",
8+
"--disable=W1203",
9+
"--init-hook=import sys; sys.path.append('source')",
10+
]
11+
}

‎.vscode/tasks.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "Development",
6+
"type": "shell",
7+
"dependsOn": [
8+
"Create VENV",
9+
"Configure VENV",
10+
"Configure PATH",
11+
],
12+
"dependsOrder": "sequence",
13+
"group": {
14+
"kind": "build",
15+
"isDefault": true
16+
}
17+
},
18+
{
19+
"label": "Create VENV",
20+
"type": "shell",
21+
"windows": {"command": "New-Item -Path '.env' -ItemType 'file' -Value '' -Force"},
22+
"osx": {"command": "touch .env"}
23+
},
24+
{
25+
"label": "Configure VENV",
26+
"type": "shell",
27+
"windows": {"command": "python -m venv .venv; .venv/Scripts/activate; python -m pip install --upgrade pip; pip install -r requirements.txt"},
28+
"osx": {"command": "python3 -m venv .venv; source .venv/bin/activate; python3 -m pip install --upgrade pip; pip install -r requirements.txt"}
29+
},
30+
{
31+
"label": "Configure PATH",
32+
"type": "shell",
33+
"windows": {"command": "New-Item -Path .venv/Lib/site-packages/main.pth -ItemType file -Value $(Join-Path -Path $(pwd) -ChildPath 'source') -Force"},
34+
"osx": {"command": "echo $(pwd)/source > .venv/lib/python3.12/site-packages/main.pth"}
35+
}
36+
]
37+
}

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
# python-software-template
1+
# Python software template
2+
This is a mock python software template which i mostly use to deploy python software

‎docs/dev_checklist.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 1. Planning
2+
- [ ] Obtain system requirements.
3+
- [ ] Obtain software requirements (what it will do, users, etc).
4+
5+
# 2. Analysis
6+
- [ ] Time estimation
7+
8+
# 3. System Design
9+
- [ ] UML diagram (use case and/or class and/or sequence)
10+
- [ ] Program flowchart
11+
- [ ] External technologies to be used (e.g., SQL Server, Redis)
12+
13+
# 4. Development, Testing, and Documentation
14+
## 4.1. One Time
15+
- [ ] CI/CD flow
16+
17+
### 4.1.1. Logs
18+
- [ ] Clear logging objectives
19+
- [ ] Correct use of log levels
20+
- [ ] Structured logs
21+
- [ ] Meaningful log entries
22+
- [ ] Log sampling
23+
- [ ] Use canonical log lines
24+
- [ ] Do not log sensitive data
25+
- [ ] Do not use logs for monitoring
26+
27+
## 4.2. Per Cycle
28+
- [ ] Module development
29+
- [ ] Test creation
30+
- [ ] User and developer documentation
31+
32+
### 4.2.1. Documentation
33+
- [ ] Code should be coherent, variable names self-explanatory, and functions should have a single purpose.
34+
- [ ] Local code should be self-explanatory or provide hints about the surrounding system.
35+
- [ ] Comments should be avoided as they are double work; code should be self-explanatory, use as a last resort.
36+
- [ ] Insertion into the data dictionary, inputs, and outputs
37+
38+
### 4.2.1. Tests
39+
- [ ] Unit tests for all modules
40+
- [ ] Verify the written tests
41+
42+
# 5. Implementation
43+
44+
# 6. Maintenance
45+
- [ ] Issue opening configuration

‎docs/diagrams.drawio‎

Whitespace-only changes.

‎docs/menu.md‎

Whitespace-only changes.

‎docs/references.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# References
2+
Guidance so you use the market best-practices in your code
3+
4+
1. [google style guide](https://google.github.io/styleguide/pyguide.html)
5+
2. [hitchhikers python guide](https://docs.python-guide.org/)
6+
3. [Software Documentation Types and Best Practices](https://blog.prototypr.io/software-documentation-types-and-best-practices-1726ca595c7f)
7+
4. [Software Documentation Examples to Inspire You](https://www.youtube.com/watch?v=mCw9h0jIuqk)
8+
5. [What is SDLC?](https://resources.github.com/software-development/what-is-sdlc/)
9+
6. [Software Development Life Cycle (SDLC)](https://www.geeksforgeeks.org/software-development-life-cycle-sdlc/)
10+
7. [Software Development Checklist](https://www.checklistsformanagers.com/checklist/software-development-checklist)
11+
8. [Complete Checklist of Software Development Life Cycle](https://dcastalia.com/blog/complete-checklist-of-software-development-life-cycle/)
12+
9. [Great Software Development Video](https://www.youtube.com/watch?v=SaCYkPD4_K0)
13+
10. [The Ultimate Guide to Becoming a Python Software Developer](https://medium.com/@e.ghelbur/the-ultimate-guide-your-path-to-becoming-a-python-software-developer-c4ad7020d999)
14+
11. [UML Use Case](https://www.youtube.com/watch?v=6XrL5jXmTwM)
15+
12. [UML Class](https://www.youtube.com/watch?v=4emxjxonNRI)
16+
13. [UML Sequence](https://www.youtube.com/watch?v=pCK6prSq8aw)
17+
14. [UML Diagrams](https://www.uml-diagrams.org/)
18+
15. [Software Documentation](https://www.youtube.com/watch?v=mCw9h0jIuqk)
19+
16. [SCRUM](https://www.youtube.com/watch?v=SWDhGSZNF9M)
20+
17. [Docs Meme](https://youtu.be/KSs5UR4jC1Q?t=242)
21+
18. [Naming Convention for Git Repositories](https://stackoverflow.com/questions/11947587/is-there-a-naming-convention-for-git-repositories)
22+
19. [10 GitHub Repository Naming Best Practices](https://climbtheladder.com/10-github-repository-naming-best-practices/)
23+
20. [GitHub Repository Best Practices](https://dev.to/pwd9000/github-repository-best-practices-23ck)
24+
21. [GitHub Repository Structure Best Practices](https://medium.com/code-factory-berlin/github-repository-structure-best-practices-248e6effc405)

0 commit comments

Comments
 (0)