Python Project Template

Last update: Dec 29, 2022

Overview

Python Project Template

A low dependency and really simple to start project template for Python Projects.

See also Flask-Project-Template for a full feature Flask project including database, API, admin interface, etc.

HOW TO USE THIS TEMPLATE

DO NOT FORK this is meant to be used from Use this template feature.

Click on Use this template
Give a name to your project
(e.g. my_awesome_project recommendation is to use all lowercase and underscores separation for repo names.)
Wait until the first run of CI finishes
(Github Actions will process the template and commit to your new repo)
If you want codecov Reports and Automatic Release to PyPI
On the new repository settings->secrets add your PIPY_API_TOKEN and CODECOV_TOKEN (get the tokens on respective websites)
Read the file CONTRIBUTING.md
Then clone your new project and happy coding!

NOTE: WAIT until first CI run on github actions before cloning your new project.

What is included on this template?

🖼️ Templates for starting multiple application types:
- Basic low dependency Python program (default) use this template
- Flask with database, admin interface, restapi and authentication use this template. or Run make init after cloning to generate a new project based on a template.
📦 A basic setup.py file to provide installation, packaging and distribution for your project.
Template uses setuptools because it's the de-facto standard for Python packages, you can run make switch-to-poetry later if you want.
🤖 A Makefile with the most useful commands to install, test, lint, format and release your project.
📃 Documentation structure using mkdocs
💬 Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release.
🐋 A simple Containerfile to build a container image for your project.
Containerfile is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.
🧪 Testing structure using pytest
✅ Code linting using flake8
📊 Code coverage reports using codecov
🛳️ Automatic release to PyPI using twine and github actions.
🎯 Entry points to execute your program using python -m or $ project_name with basic CLI argument parsing.
🔄 Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.

Curious about architectural decisions on this template? read ABOUT_THIS_TEMPLATE.md
If you want to contribute to this template please open an issue or fork and send a PULL REQUEST.

project_name

project_description

Install it from PyPI

pip install project_name

Usage

from project_name import BaseClass
from project_name import base_function

BaseClass().base_method()
base_function()

$ python -m project_name
#or
$ project_name

Development

Read the CONTRIBUTING.md file.

Comments

Rename-project won't run by default

Describe the bug Action Rename-project won't run without elevating workflow permissions

To Reproduce Click the link in readme ( https://github.com/rochacbruno/python-project-template/generate ) Name the project Go into actions and error should be there

Expected behavior AFAIK this can not be worked around. Probably update readme so newbs like me don't spend 30 minutes hunting git docs for a solution. I have like 1 hour of work experience in GitHub so can't advise how it should be solved.

Error Log remote: Permission to jdobruchowski/Oracle-REST-SQL-util-.git denied to github-actions[bot]. fatal: unable to access 'https://github.com/jdobruchowski/Oracle-REST-SQL-util-/': The requested URL returned error: 403 Error: Invalid status code: 128 at ChildProcess. (/home/runner/work/_actions/stefanzweifel/git-auto-commit-action/v4/index.js:17:19) at ChildProcess.emit (events.js:314:20) at maybeClose (internal/child_process.js:1022:16) at Process.ChildProcess._handle.onexit (internal/child_process.js:287:5) { code: 128 } Error: Invalid status code: 128 at ChildProcess. (/home/runner/work/_actions/stefanzweifel/git-auto-commit-action/v4/index.js:17:19) at ChildProcess.emit (events.js:314:20) at maybeClose (internal/child_process.js:1022:16) at Process.ChildProcess._handle.onexit (internal/child_process.js:287:5)
bug help wanted

opened by jdobruchowski 2
fix typo
Summary :memo:

Small fix for a typo in readme.md file

Details

changed readme.md

Checks

[ ] Closed #798

[ ] Tested Changes

[ ] Stakeholder Approval
opened by osbm 0
cleanups
Summary :memo:

Write an overview about it.

Details

Describe more what you did on changes.

(...)

(...)

Bugfixes :bug: (delete if dind't have any)

Checks

[ ] Closed #798

[ ] Tested Changes

[ ] Stakeholder Approval
opened by rochacbruno 0
wrong version pushed to pypi
https://github.com/rochacbruno/python-project-template/blob/3b55b1c022d54fba2c8604cc56d7daccba310352/Makefile#L82-L87

maybe the line

@git tag $${TAG}

should be moved to behind the line

@git commit -m "release: version $${TAG} 🚀"

?

Thanks for your effort. A very useful template.
opened by oirontro 0
Add basic ArgParse example

The file https://github.com/rochacbruno/python-project-template/blob/main/project_name/main.py is missing a simple implementation of a CLI using ArgParse from stdlib.

opened by rochacbruno 0
[bug] Fix generation when project name has dashes and upper case

Example of generated repo

https://github.com/rochacbruno/This-Is_Great

This-Is_Great is replaced as This_Is_Great and it doesn't match repo URL.

Read a new variable on rename_project.sh script and job, use this as repo_slug on specific places as readme badges and URLS.
bug

opened by rochacbruno 0

Releases(0.1.2)

0.1.2(Aug 14, 2021)

Bruno Rocha (2):
      release: version 0.1.0
      Fix release, README and windows CI

Source code(tar.gz)
Source code(zip)

Owner

Bruno Rocha

Programmer at @RedHatOfficial. #Python #Rust . Working on: @ansible @python #dynaconf @codeshow

GitHub Repository https://github.com/rochacbruno/python-project-template/generate

A lightweight and unlocked launcher for Lunar Client made in Python.

LCLPy LCL's Python Port of Lunar Client Lite. Releases: https://github.com/Aetopia/LCLPy/releases Build Install PyInstaller. pip install PyInstaller

21 Aug 03, 2022

Jarvis Python BOT acts like Google-assistance

Jarvis-Python-BOT Jarvis Python BOT acts like Google-assistance Setup Add Mail ID (Gmail) in the file at line no 82.

1 Jan 08, 2022

Grimoire is a Python library for creating interactive fiction as hyperlinked html.

Grimoire Grimoire is a Python library for creating interactive fiction as hyperlinked html. Installation pip install grimoire-if Usage Check out the

5 Oct 11, 2022

importlib_resources is a backport of Python standard library importlib.resources module for older Pythons.

importlib_resources is a backport of Python standard library importlib.resources module for older Pythons. The key goal of this module is to replace p

36 Dec 13, 2022

Sentiment Based Product Recommendation System

Sentiment Based Product Recommendation System The e-commerce business is quite p

2 Jan 15, 2022

Prometheus exporter for chess.com player data

chess-exporter Prometheus exporter for chess.com player data implemented via chess.com's published data API and Prometheus Python Client Example use c

7 Feb 28, 2022

A stupid obfuscation thing

StupidObfuscation A stupid obfuscation thing How it works The obfuscator takes a string, splits into pieces of one, then, using the table from letter.

2 May 03, 2022

An electron application to check battery of bluetooth devices connected to linux devices.

bluetooth-battery-electron An electron application to check battery of bluetooth devices connected to linux devices. This project provides an electron

15 Dec 03, 2022

For Tok-k passages that have passed through the Bi-Encoder Retrival, ReRank is performed using CrossEncoder.

Cross-Encoder-with-Bi-Encoder For Tok-k passages that have passed through the Bi-Encoder Retrival, ReRank is performed using CrossEncoder. Data Data u

7 Feb 09, 2022

InverterApi - This project has been designed to take monitoring data from Voltronic, Axpert, Mppsolar PIP, Voltacon, Effekta

2 Sep 03, 2022

Python Project Template

Related tags

Overview

Python Project Template

HOW TO USE THIS TEMPLATE

What is included on this template?

project_name

Install it from PyPI

Usage

Development

Comments

Rename-project won't run by default

fix typo

Summary :memo:

Details

Checks

cleanups

Summary :memo:

Details

Bugfixes :bug: (delete if dind't have any)

Checks

wrong version pushed to pypi

Add basic ArgParse example

[bug] Fix generation when project name has dashes and upper case

Releases(0.1.2)

0.1.2(Aug 14, 2021)

Owner

Bruno Rocha

A lightweight and unlocked launcher for Lunar Client made in Python.

Jarvis Python BOT acts like Google-assistance

Grimoire is a Python library for creating interactive fiction as hyperlinked html.

importlib_resources is a backport of Python standard library importlib.resources module for older Pythons.

Sentiment Based Product Recommendation System

Prometheus exporter for chess.com player data

A stupid obfuscation thing

An electron application to check battery of bluetooth devices connected to linux devices.

For Tok-k passages that have passed through the Bi-Encoder Retrival, ReRank is performed using CrossEncoder.

InverterApi - This project has been designed to take monitoring data from Voltronic, Axpert, Mppsolar PIP, Voltacon, Effekta

Never see escaped bytes in output.

Code for the manim-generated scenes used in 3blue1brown videos

Program Input Data Mahasiswa Oop

i3wm helper tool for workspaces on multiple monitors

Python - Aprendendo Python na ByLearn

propuestas electorales de los candidatos a constituyentes, Chile 2021

qecsim is a Python 3 package for simulating quantum error correction using stabilizer codes.

Hashcrack - A non-object oriented open source, Software for Windows/Linux made in Python 3

Plux - A dynamic code loading framework for building plugable Python distributions

A conda-smithy repository for boost-histogram.