Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unfor19/python-project
Python project structure, relative imports, absolute imports, packages, and modules. Let's make it simpler.
https://github.com/unfor19/python-project
project python structure tutorial
Last synced: 3 months ago
JSON representation
Python project structure, relative imports, absolute imports, packages, and modules. Let's make it simpler.
- Host: GitHub
- URL: https://github.com/unfor19/python-project
- Owner: unfor19
- Created: 2020-08-30T18:11:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-27T00:00:01.000Z (about 4 years ago)
- Last Synced: 2024-09-16T18:10:17.059Z (3 months ago)
- Topics: project, python, structure, tutorial
- Language: Python
- Homepage:
- Size: 98.6 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# python-project
This project attempts to consolidate best-practices all around the area of creating a Python package, including the development process, and package distribution process.
Visit this project's [Wiki Pages](https://github.com/unfor19/python-project/wiki) (docs) to learn how it all works.
## Quick Start
To run the application, go ahead and use pip or Docker.
### pip
Requires Python v3.6 and above
```
$ pip install -U unfor19-appy
$ appy
Created the file: $HOME/python-project/meirg-ascii.txt
Insert your name: meir gabay
Hello Meir Gabay, here's the cat fact of the day:
Unlike humans, cats do not need to blink their eyes on a regular basis to keep their eyes lubricated.
$ cat $HOME/python-project/meirg-ascii.txt
```
### Docker
Requires [Docker](https://docs.docker.com/get-docker/)
```bash
$ docker run --rm -it unfor19/appy bash
$ (container) appy
Created the file: /app/meirg-ascii.txt
... # Same as above
$ (container) cat /app/meirg-ascii.txt
```
Expand/Collapse - contents of meirg-ascii.txt
```
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
......................................................::!!!!!::::.......................................................
.................................................:!*$%@S#&$$$@@$%*%**!:.................................................
.............................................:!*@&&@$::::.........::!$@%!!:.............................................
...........................................!@&@%%:.....................::!*!:...........................................
.........................................*%:.............................::!!.........................................
.......................................!@&*:.................................:!::.......................................
.....................................:@$*.......................................:!:.....................................
....................................*#$:..........::::::........::::::.............:....................................
...................................$S*............!&&&&@:......:@&&&&*.............::...................................
..................................@#:.............!&&%&&$......%&&%@&*................:.................................
.................................$S!..............!&@%$&&!....!&&@%@&*................:.................................
................................%S!...............!&@$$@&@:...$&@$$@&*................:.................................
...............................!B&................!&@$&$&&*..*&&$&$@&*................::................................
...............................!&!................!&@$&@$&@::@&@$&$@&*.................:................................
...............................$&.................!&@$&&$@&%%&&$&&$@&*..................................................
...............................@#.................!&@$&&&$&&&&$@&&$@&*..................................................
...............................@@.................!&@$&&&$$&&@$&&&$@&*..................:...............................
...............................@&.................!&@$&@@&$@&$&@$&$@&*.................%!...............................
...............................%S:................!&@$&$!&@$$@&*%&$@&*................:S!...............................
...............................:B%................!&@$&$.%#$$#$.%&$@&*................%B:...............................
...............................:B#:...............!&@$&$.:$$$$!.%&$@&*................#@................................
................................&B$...............!&@$&$........%&$@&*...............$S:................................
................................:#S:..............!&@$&$........%&$@&*..............*B%.................................
.................................:S#:.............!&&$&$........%&$@&*.............!S@..................................
..................................!S&:............!&$%&$........%&%$&*............*S@...................................
...................................:&B$...........:!..:!........::..::..........:@B$....................................
.....................................%B@:......................................*#S*.....................................
......................................!##@!..................................!&S@:......................................
........................................*&S@*:.............................*@#$:........................................
..........................................!$SS&*:......................:!@&@%:..........................................
............................................:*@###$*!:...........:::!$&&@%:.............................................
................................................!%@$$@&&@@&@@$#&$%!:................................................
......................................................:!!*%%%%*!!::.....................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
....................!!!!:.......!!!!:.....!!!!!!!!!!!!!.....:!!!!.....!!!!!!!!!!!:.........:!!!!!!!:....................
..................!&&$$%@!....!&$$$$$...*#@$@@@@@@@@@$&*..:$S$$$&:..!&&$$@@@@@@$%$%......!$$$$$$$$$$$:..................
.................:S#@*%%*@!..%B$*%%%@..!SB$%%*********@*..@BB*%*@!.:#B@*%%********$$...:$#%%%%%%%%%%%@:.................
.................!&@@%%%%*@:*B$*%%%%@..*#&$%%%SSSSSSS#$:..@##*%*@!.!@#@*%*SSSSS#*%!&:..&B@%%%SBSSS%%*@*.................
.................!@%%%%%*&B$*%%%%%@..*&@$%%%S&&&&&&%....@@&*%*@!.!&&@*%*#$$SBB*%!@!.!##$%%$&%@BBS##@:.................
.................!&@@%%%%%%%$*%%%%%%@..*&@$%%%$$$$$$$@*...@@&*%*@!.!&@@*%%@%%@#@%%!&:.*&&$%%$%:@####&$!.................
.................!&@@%%*&%*%%%!&$*%%@..*&&$%%*%%%%%%*@%...@@&*%*@!.!&@@*%%%%%%%%**$*..*&@$%%$#B#!%%%*$%.................
.................!&@@%%*BB$$$%&B@*%%@..*&@$%%%SBBBBB#%:...@@#*%*@!.!&@@*%*@&&%*%!&!...*&&$%%%BBS@@%%*$*.................
.................:#@@%%*BBBBS@#&@*%%@..*&&$%%%#####&$*%:..@@&*%*@!.!#@@*%*BBBB*%%%$...*#&$%%%SSSSS%%*$*.................
.................!@*%*&!!!::&@@*%%@..!S#$%%*******%*@*..@&S*%*@!.!&&@*%*@$BBS*%*$%..!BBS****%%%***%@:.................
.................:SB#@@@$....:S##$@@$..!BB&$@@@@@@@@@@&*..@BB$$$&:.:SB&$@@$.&BB&$@$&:..&BBB@$@$$@@@@%:..................
.................:SBBBS%:....:SBBBS%:..!BBBBBBBBBBBBB&*...@BBBB@!..:SBBBS%:.:SBBBB@!...:$#BBBBBBB#$!....................
..................:!!!:.......:!!!:.....:!!!!!!!!!!!!.....:!!!:.....:!!!:....:!!!:........:!!!!!:.......................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
........................................................................................................................
```
## References
- [packaging python](https://packaging.python.org/tutorials/packaging-projects/)
- [python-packaging-tutorial](https://python-packaging-tutorial.readthedocs.io/en/latest/setup_py.html)
- [python sample project](https://github.com/pypa/sampleproject)
- [setuptools package discovery](https://setuptools.readthedocs.io/en/latest/userguide/package_discovery.html)
## Authors
Created and maintained by [Meir Gabay](https://github.com/unfor19)