fostiropoulos / pytemplate

A template for python projects with the essentials and a bit more

Home Page:https://iordanis-pytemplate.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python Template

The goal of this template project is to provide a good starting point of all the reasonable defaults when building your python project. Some of these include:
  1. Documentation
  2. Packaging
  3. CI/CD actions
  4. Static Analysis
  5. Tests

To start:

$ bash scripts/init.sh

You will be prompted to enter:

Enter project name: _____
Enter project description: _____
Enter project project website: _____
Enter minimum python version: _____
Enter project author name: ______
Enter project author email: ______
Enter git project url: _____

For git project url enter the git url where the project will be pushed to.

Usage

CI/CD actions are used to make sure your code is not breaking. You should set-up and configure your github actions. The actions are located in this folder. You should set-up two repository secrets as explained HERE.

About

A template for python projects with the essentials and a bit more

https://iordanis-pytemplate.readthedocs.io/en/latest/


Languages

Language:Shell 68.9%Language:Makefile 21.2%Language:Python 9.9%