This is a Python project skeleton layout and setup.
It includes typical files, metadata and configurations for initiating, developing, testing, linting and packaging a Python project.
Clone the repo to where you want to create you new project:
$ cd /path/to/projects
$ git clone https://github.com/ostpoller/pyprjtpl.git project_nameTo use the template for your project run the script configure_project.sh.
This will replace the placeholders in all files with your project and package name
as well as the package directory name.
The script is replacing the .git local repository directory with a freshly initialised one
and creates and checks out the develop branch.
Finally, the configure script runs some tests to check, everything has been done successfully.
You are responsible to create a Python virtual environment for your project. After creation activate it and install the dependencies for the project setup:
$ cd /path/to/projects/project_name
$ python3 -m venv venv
$ source venv/bin/activate
(venv)$ pip install -r requirements_dev.txtDevelop your package, add your project dependensies to requirements.txt and use make
to execute typical chores like running the test case suite, lint your code, create documentation,
bump the version or lock your dependencies.
(venv)$ cd /path/to/projects/project_name
(venv)$ make testn/a
- 0.1.0
- The initial release
https://github.com/ostpoller/pyprjtpl/issues
Philipp WESTPHAL – [email protected]
Distributed under the MIT license. See LICENSE for more information.