Python template

Table of content, automatically updates on save via yzhang.markdown-all-in-one .

• Python template
  • About the project
    • Built with
  • Setup
    • Prerequisites
    • Installation
      • In a completely new repository
      • Into an existing repository
      • Poetry
      • Suggested VSCode extensions
  • Usage
  • Testing
  • Roadmap
  • Contributing
  • License
  • Contributors
  • Acknowledgments

About the project

One sentence summarizing the motivation and value proposition this project provides.

Generic Python VSCode template with opinionated configuration.

Built with

Frameworks used for this project.

Setup

Prerequisites

Prerequisites for installation.

Installation

How to install.

In a completely new repository

git remote add template https://github.com/StephanSchmiedmayer/PythonTemplate.git
git pull template main
git reset $(git commit-tree HEAD^{tree} -m ".") && git commit --amend -m "Add template"
git remote rm template

Step by step explanation:

1. Add this repo as a remote repository called template:

   git remote add template https://github.com/StephanSchmiedmayer/PythonTemplate.git

2. Pull the template into your current branch:

   git pull template main

   Be aware that this will also add the MIT License of this project.

3. Squash all commits to a single initial commit:

   git reset $(git commit-tree HEAD^{tree} -m ".") && git commit --amend -m "Add template"

4. Remove template remote:

   git remote rm template

Into an existing repository

git remote add template https://github.com/StephanSchmiedmayer/PythonTemplate.git
git checkout template/main -- .gitignore README.md LICENSE.md .vscode/settings.json

Poetry

[Once per machine] Make sure poetry puts the virtual environment into this project, otherwise VSCode can have problems picking it up. For more info see stackoverflow.

poetry config virtualenvs.in-project true

Suggested VSCode extensions

• njpwerner.autodocstring
• ms-python.black-formatter
• streetsidesoftware.code-spell-checker
• ms-vscode-remote.remote-containers
• ms-azuretools.vscode-docker
• ms-python.flake8
• donjayamanne.githistory
• visualstudioexptteam.vscodeintellicode
• visualstudioexptteam.intellicode-api-usage-examples
• ms-python.isort
• yzhang.markdown-all-in-one
• davidanson.vscode-markdownlint
• matangover.mypy
• christian-kohler.path-intellisense
• cs50.vscode-presentation-mode
• ms-python.vscode-pylance
• ms-python.pylint
• ms-python.python
• mukundan.python-docs
• donjayamanne.python-environment-manager
• kevinrose.vsc-python-indent
• avaly.restore-git-branch-tabs-improved
• lextudio.restructuredtext
• trond-snekvik.simple-rst

Usage

How to use the software / library. If necessary include any warnings about common problems / misusage.

Testing

How to execute the test suite.

Roadmap

Where is this project currently going?

Contributing

How to contribute to the project.

License

See License.md.

Contributors

Stephan Schmiedmayer

Acknowledgments

Thank anybody who helped with this project.