This is a Python project template using Fibonacci number as example, well organized with package, configuration, testing, and documentation. It's very suitable as the starting point for a new project.
| File |
Description |
| .gitignore |
Git configuration to ignore files |
| COMMANDS |
Instruction of common commands |
| LICENSE |
License declaration |
| MANIFEST.in |
List of additional files to attach |
| README.rst |
Project instruction |
| setup.cfg |
Configurations |
| setup.py |
Build script for setuptools |
| requirements.txt |
Dependencies |
| docs |
Documentation directory |
| fibonacci |
Main package directory |
| fibonacci/bin |
Command line tools directory |
| tests |
Unit tests directory |
Install:
From code:
import fibonacci
f = fibonacci.compute(5)
From command line:
$ fibonacci 5
> [2020-03-03 12:34:56 +0800][fibonacci.bin][INFO] Fibonacci(5) = 5