A simple and modern template for Python module development with additional workflows, code linting checks, etc. to quickly build necessary file structure. The repository is build as a template repository that can be used to create the same directory structure, branches (optional) and files. To create a repository from this template:
- Select "Use this Template" > "Create New Repository" from the dropdown menu,
- Optionally, you can include all the branches (not-recommended) from the menu, and
- Follow the steps to create repository information and choose the visibility.
Introduced in 2019, users can now create a repository from templates in GitHub. To do this, simply head over to any repository
settings and enable "Template Repository" from the Options Menu. When creating a new repository from this template, you can
just click on Use this Template available in this repository (refer the picture below).
The template repository is not limited to GitHub, but can be widely used by using simple shell commands to copy and sync the contents like below:
rsync -rh ~/source/directory /destination/directoryThe above tool reflects the wide adaptibility and simplicity of usage of the code that provides forward integration with any external models/libraries.
This repository follows MIT License but you're free to use any type of license; choose a type of licese as suitable for your project/required by your organization.
The project is configured with utility workflows for continuous integration and development for automating process like dependency checks, code lintings, etc. The following workflows are available.
The workflow can be used to automatically check for requirements that can be required by the
package. To use this, a requirements.txt file needs to be maintained, on which a new PR is automatically created when a new
release is available. To use this effectively, create two new labels pip and dependencies for the repository, as the
bot can automatically label the new pull requests accordingly.
Use the command flake8 . --count --exit-zero --max-complexity=10 --statistics to generate a report.