Auth & Security Testbench

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.
• FastAPI-Project-Template  The base to start an openapi project featuring: SQLModel, Typer, FastAPI, JWT Token Auth, Interactive Shell, Management Commands.

HOW TO USE THIS TEMPLATE

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

1. Click on Use this template 
2. Give a name to your project
   (e.g. my_awesome_project recommendation is to use all lowercase and underscores separation for repo names.)
3. Wait until the first run of CI finishes
   (Github Actions will process the template and commit to your new repo)
4. If you want codecov  Reports and Automatic Release to PyPI 
   On the new repository settings->secrets add your PYPI_API_TOKEN and CODECOV_TOKEN (get the tokens on respective websites)
5. Read the file CONTRIBUTING.md 
6. 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 <auth_test> or $ auth_test 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.

❤️ Sponsor this project 

auth_test

Awesome auth_test created by vitorecomp

Install it from PyPI

pip install auth_test

Usage

from auth_test import BaseClass
from auth_test import base_function
 
BaseClass().base_method()
base_function()

$ python -m auth_test
#or
$ auth_test

Development

Read the CONTRIBUTING.md  file.