Skip to content
/ python-starter Public template

Kitam Studios - Template for Python Applications

Notifications You must be signed in to change notification settings

kitamstudios/python-starter

Repository files navigation

Continuous Integration

Kitam Studios - Template for Python Applications

Getting started

conda env create -f .environment.yml
pip install -r requirements.txt

Available out of the box

  • Core
    • editorconfig, black, prospector
    • Unit tests: pytest
  • VSCode
    • editorconfig, prospector, black
    • Unit test: auto run, run, debug
    • Settings
    • Recommended extensions
    • F5 debugging from VSCode
  • CI/CD
    • GitHub workflow: black, prospector, unit tests
  • TODO
    • pre-commit integration

Useful documents

Available Scripts

In the project directory, you can run:

  • Style check: black . --check --color --diff --target-version py37
  • Lint: prospector
  • Unit tests: pytest

Other Miscellaneous

Environment setup

  • Create new environment

    • Setup conda
      conda deactivate
      conda env remove --name my.py.proj.1
      conda create --name my.py.proj.1 python=3.7
      conda activate my.py.proj.1
    • Install dependencies
      # conda install numpy
      
  • Export environment

    conda env export --name my.py.proj.1 >.environment.yml
  • Import environment

    conda env create -f .environment.yml
  • Load anaconda:

    & 'C:\Users\partho\Anaconda3\shell\condabin\conda-hook.ps1' ; conda activate 'C:\Users\partho\Anaconda3' ; cd d:\src\c

About

Kitam Studios - Template for Python Applications

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages