py-vs-github-starter 0.2.1

Starter python library project for VSCode AND Github with built-in features;

py-stars

Description

Starter python library project for VSCode with built-in features:

• Preconfigured venv with linters and formatters
• Unit tests to run in tests.py
• README.md template (this one)
• Preconfigured lint.yml for GitHub Workflow
• Preconfigured ci.yml for Github Workflow (runs test.py unit tests)
• Preconfigured .gitignore file

Example :

Input

Output

Usage

Installation

• Clone this repo
• Open a terminal in local folder
• Create virtual environment :

   py -3 -m venv .venv
   .venv\scripts\activate

• Install dependencies :

   python -m pip install --upgrade pip
   pip install -r requirements.txt

• Enjoy !

tests.py

This file can be run :

• in debugger using the preconfigured "Launch current file" debug config
• in Tests explorer tab
• via Terminal with :

python -m unittest tests.py

Changelog

Initial release.

TODO

• PyPI generation in CI step
• Autogenerated doc
• Preconfigured logger
• Main template ?
• Module template ?
• Architecture hierarchy ?