dannydannydanny/methodology
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📝 python

Browse source
This commit is contained in:
dannydannydanny 2021-09-28 12:37:46 +02:00 • committed by GitHub
parent 01a0dfe908
commit de79262029
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -73,7 +73,19 @@ pipenv run python .
#cd .. && rm -rf cool-user-repo-online #cd .. && rm -rf cool-user-repo-online
``` ```
## Develop with Version Control ## Develop
### Python Developement
* Python Standard Library:
* [argparse](https://docs.python.org/3/library/argparse.html) to build CLI programs
* [pathlib](https://docs.python.org/3/library/pathlib.html) for file-IO
* Pyhon modules
* [pipx](https://pypi.org/project/pipx/) or [pyenv](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/) for environment management.
* [Fabric](https://www.fabfile.org/) for deployment over SSH
* Avoid [code smells](https://refactoring.guru/refactoring/smells)
### Develop with Version Control
```sh ```sh
# Git Log A DOG acronym # Git Log A DOG acronym
@ -136,22 +148,6 @@ Context:
# -> feature1 is rejected and made obsolete # -> feature1 is rejected and made obsolete
``` ```
# Python
Packages we like:
* Python Standard Library:
* [argparse](https://docs.python.org/3/library/argparse.html) to build CLI programs
* [pipx](https://pypi.org/project/pipx/) or [pyenv](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/).
environment management.
* [Fabric](https://www.fabfile.org/) for deployment over SSH
### Pathlib
For navigating, reading and filesystem and file read/write.
```
from pathlib import Path
Path('.').iterdir()
Path('.').absolute()
```
* **Documentation** * **Documentation**
* Use [Google's Markdown Style Guide](https://google.github.io/styleguide/docguide/style.html) for written documentation. * Use [Google's Markdown Style Guide](https://google.github.io/styleguide/docguide/style.html) for written documentation.
* Conceptual graphical documentation as inline embedded images. * Conceptual graphical documentation as inline embedded images.