python_template

Summary

Oftentimes the initial setup of a Python repo can take a few minutes to a couple hours. By laying the foundation to rapidly implement an idea, can focus on the good bits instead of DevOps drudgery.

Star History

Caveat Emptor

Very little of this gets tested on Windows hosts. Windows Subsystem for Linux (WSL) is used where necessary with the default Ubuntu LTS install. Moved bulk of document to the markdown directory to opt-in vs. opt-out of documentation.

Be the change et al if Windows is your main and you wanna raise a PR with broad instructions on getting tooling working under Windows (e.g., docker, poetry, playwright.)

Table of Contents

• python_template
  • Summary
    • Caveat Emptor
  • Setup
  • Usage
    • Mac and Linux users
  • Pushing to Docker Hub with CI
    • What you need to modify in this file
  • TODO

Setup

• Install
  • editorconfig
  • wsl
  • asdf
  • poetry
  • docker-compose
  • playwright
  • Kubernetes (k8s)
  • justfile

Usage

Mac and Linux users

Development environments and tooling are first-class citizens on macOS and *nix. For Windows faithfuls, please setup WSL.

Pushing to Docker Hub with CI

Docker Hub is a cloud-based repository in which Docker users and partners create, test, store and distribute container images. Docker images are pushed to Docker Hub through the docker push command. A single Docker Hub repository can hold many Docker images (stored as tags).

Automated CI is implemented via GitHub Actions to build and push this repository's image to Docker Hub in .github/workflows/ci.yml.

What you need to modify in this file

• Add repository secrets (Docker Hub)
  • DOCKERHUB_TOKEN
  • DOCKERHUB_USER
• Add environment variable (image name)
  • APP_NAME

Instructions to create a token.

Instructions to disable this action if you don't want this feature.

TODO

• Open Issues
• Markdown automation
  • Look for an extension similar to Markdown All in One that updates file/directory links when they move
• Webdev
  • Django
    • Merge with docker_python and put the latter on an ice float
    • Django Ninja
  • Flask
    • Bonus points for Svelte front-end ❤️
  • FastAPI
• SQL
  • MySQL
  • PostgreSQL
  • SQLite
• NoSQL
  • MongoDB
    • Switch to docker-compose
    • Fix unique index deleting too many keys
  • Redis
• DevOps
  • Cloud Native
    • AWS
    • Azure
    • GCP
    • k8s
      • ~/.kubeconfig
      • Kompose
      • Helm
      • minikube
        • Expand usage and syntax
    • Argo
    • Flux
    • DevSpace Covered tilt instead
  • Ansible
  • Heroku
  • justfile
  • Windows Subsystem for Linux (WSL)
    • VSCode
      • Remote WSL install and usage
        • Or at least further reading nods
• Debugging
  • Dependencies
  • script itself via icecream