This repository is a template for Python projects and acts as a starting point for new projects. You can use this template to create a new Python project with the following features:
poetryfor dependency/requirements management and virtual environment setuppytestconfiguration for testingblackconfiguration for lintingclickfor command line interfacelogurufor logging setup at different levelsDockerfileanddocker-composesetup for containerizationMakefilewith common tasks
To create a new project using this template, run the following command:
export APP_NAME=my-new-app
git clone --recursive https://github.com/ylogx/python-chassis.git ${APP_NAME} && cd ${APP_NAME} && bin/new-projectThis will clone the repository and setup code for your new specified App Name.
This will install dependencies and setup a virtual environment for the project.
You can use poetry commands to manage dependencies and virtual environment.
Here's how the installation looks like:
To run the project, use the following command:
make lint test # Perform linting and test
make runYou can find more useful commands in the Makefile.