Skip to content

dbwitso/dev.bootsrap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

Dev Bootstrap Script Documentation

Overview

The dev bootstrap script sets up a professional development environment on Ubuntu/Debian Linux or macOS. It is idempotent, meaning it can be safely run multiple times. The script installs essential packages, Python tools, Git configuration, SSH keys, and terminal utilities, while adding convenient virtual environment management commands.


Features

  1. Cross-platform support

    • Ubuntu/Debian Linux
    • macOS
  2. Idempotent

    • Skips installation or configuration if already present
    • Safe to rerun on the same machine
  3. Python environment setup

    • Installs Python 3, pip, and pipx

    • Provides virtualenvwrapper-style commands:

      • mkvirtualenv <env> – create and activate a virtual environment
      • workon <env> – activate an existing virtual environment
      • rmvirtualenv <env> – remove a virtual environment
      • lsvirtualenv – list all virtual environments
      • mkproject <project> – create a project folder with git + virtualenv + initial commit
  4. Global Python CLI tools (via pipx)

    • poetry – dependency management
    • black – code formatting
    • pre-commit – automatic pre-commit hooks
  5. Git configuration

    • Prompts for username and email if not set
    • Configures globally
  6. SSH key setup for GitHub

    • Generates an ED25519 key if missing
    • Adds it to the SSH agent
    • Shows public key for adding to GitHub
  7. Terminal productivity tools

    • fzf – fuzzy finder
    • ripgrep – fast search
    • bat – improved cat
    • eza – modern ls
  8. Progress feedback

    • Shows what was installed, configured, or skipped
    • Uses clear text messages

Requirements

  • Python 3 installed (the script can install it if missing)
  • Administrative privileges (sudo) on Linux or macOS
  • Internet connection for downloading packages and pipx tools
  • Shell: Bash or Zsh

Usage

  1. Download or copy the dev_bootstrap.sh script to your home directory.
  2. Make it executable:
chmod +x dev_bootstrap.sh
  1. Run the script:
./dev_bootstrap.sh
  1. Follow prompts for Git configuration and GitHub SSH key (only if missing).
  2. After completion, restart the terminal or source your shell RC file:
source ~/.bashrc   # or ~/.zshrc
  1. You can now use:
mkvirtualenv <env>     # create and activate a virtual environment
workon <env>           # activate an existing virtual environment
rmvirtualenv <env>     # remove a virtual environment
lsvirtualenv            # list all virtual environments
mkproject <project>    # create project folder with git + virtualenv + initial commit
pipx install <tool>    # install Python CLI tools globally

About

setup your new dev environment

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages