Skip to main content

No project description provided

Project description

deployvm

Python CLI for deploying web applications to cloud providers (DigitalOcean and AWS).

When setting up a VM it will:

  • Create a cloud instance (DigitalOcean droplet or AWS EC2)
  • Configure firewall rules to open ports 80, 443, and SSH
  • Create a deploy user with passwordless sudo
  • Set up a swap file
  • Upload your SSH key to the provider
  • Install uv, nginx, supervisord (FastAPI) or pm2 (Nuxt)
  • Deploy your app and configure it to run as a service
  • Set up nginx as a reverse proxy
  • Optionally provision a Let's Encrypt SSL certificate via certbot

Installation

uv tool install deployvm

Quick Start

1. Configure Provider

Create .env in your project root:

# DigitalOcean (default)
DEPLOY_VM_PROVIDER=digitalocean

# AWS
DEPLOY_VM_PROVIDER=aws
AWS_PROFILE=default
AWS_REGION=ap-southeast-2

Auth setup:

  • AWS: aws configure
  • DigitalOcean: doctl auth init

2. Deploy Your App

Without SSL:

uv run deployvm fastapi deploy my-server /path/to/app \
    "uv run uvicorn app:app --port 8000" \
    --port 8000 --no-ssl

With domain + SSL:

# 1. Get nameservers
uv run deployvm dns nameservers example.com --provider aws

# 2. Configure at registrar, wait 24-48h for propagation

# 3. Deploy with SSL
uv run deployvm fastapi deploy my-server \
    /path/to/app \
    "uv run uvicorn app:app --port 8000" \
    --port 8000 \
    --domain example.com \
    --email you@example.com

Supported app types:

  • fastapi deploy - FastAPI apps with uvicorn + supervisord

    • Requires pyproject.toml and uv for dependency management
    • App must be importable as a Python package
    • Command must be a uv run ... invocation
  • nuxt deploy - Nuxt apps with PM2

    • Requires package.json with build and start scripts
    • Node.js managed via nvm on the server
    • Builds locally by default (--local-build), uploads .output/

3. Manage Your Deployment

uv run deployvm instance verify my-server --domain example.com
uv run deployvm fastapi logs my-server
uv run deployvm fastapi restart my-server
uv run deployvm fastapi sync my-server /path/to/app "uv run uvicorn app:app --port 8000"

Common Workflows

Add SSL After Deployment

# 1. Deploy without SSL
uv run deployvm fastapi deploy my-server /path/to/app "uv run uvicorn app:app --port 8000" --port 8000 --no-ssl

# 2. Get nameservers and configure at registrar, wait 24-48h

# 3. Add SSL
uv run deployvm nginx ssl my-server example.com you@example.com

Multiple Apps on One Instance

uv run deployvm fastapi deploy my-server /path/to/api \
    "uv run uvicorn app:app --port 8000" \
    --port 8000 --app-name api --domain api.example.com --email you@example.com

uv run deployvm nuxt deploy my-server /path/to/frontend \
    --app-name frontend --port 3000 --domain example.com --email you@example.com

uv run deployvm instance apps my-server

Configuration

Environment Variables

Variable Description Default
DEPLOY_VM_PROVIDER Cloud provider (aws or digitalocean) digitalocean
AWS_PROFILE AWS CLI profile name None
AWS_REGION Default AWS region ap-southeast-2

Application Credentials

Your app's .env inside the app directory is automatically uploaded during deploy or sync.

When deploying to AWS EC2, AWS_PROFILE, AWS_ACCESS_KEY_ID, and AWS_SECRET_ACCESS_KEY are stripped (EC2 uses IAM roles), and AWS_REGION is preserved/added.

Provider Settings

Setting AWS DigitalOcean
Regions us-east-1, us-west-2, ap-southeast-2 syd1, sgp1, nyc1, sfo3, lon1
VM Sizes t3.micro, t3.small, t3.medium s-1vcpu-1gb, s-2vcpu-2gb, s-4vcpu-8gb
DNS Route53 (auto-created) DigitalOcean nameservers required
Auth aws configure doctl auth init

AWS Infrastructure Setup

When creating an EC2 instance, the script automatically handles all required AWS infrastructure:

VPC

  • Checks for an existing VPC with subnets, an attached internet gateway, and a route table with a route to the internet gateway
  • Creates a default VPC if none exists in the region

Security group

  • Creates a deploy-vm-web security group (once per region) with:
    • SSH (port 22) restricted to your current public IP
    • HTTP (port 80) open to all
    • HTTPS (port 443) open to all
  • Reuses the existing group on subsequent deploys

SSH key pair

  • Uploads your local SSH public key (~/.ssh/id_ed25519.pub etc.) to EC2 if not already registered

AMI

  • Finds the latest Ubuntu 22.04 LTS AMI from Canonical for your region

IAM role and instance profile (when Bedrock access is needed)

  • Creates an IAM role with EC2 trust policy and AmazonBedrockFullAccess managed policy
  • Creates an EC2 instance profile with the same name and attaches the role
  • Waits for IAM propagation before launching the instance

Route53 DNS (when --domain is provided)

  • dns nameservers creates a hosted zone for your domain if one doesn't exist, then returns the AWS nameservers to configure at your registrar
  • During deploy, creates or upserts A records for domain and www.domain pointing to the instance IP

AWS Bedrock Access

EC2 instances automatically get Bedrock access via IAM roles:

uv run deployvm fastapi deploy my-server /path/to/app "uv run uvicorn app:app --port 8000" --port 8000 --no-ssl
# or with custom role:
uv run deployvm fastapi deploy my-server /path/to/app "uv run uvicorn app:app --port 8000" --port 8000 --iam-role my-role --no-ssl

Your app code needs no credentials:

import boto3
bedrock = boto3.client('bedrock-runtime', region_name=os.getenv('AWS_REGION'))

Commands Reference

deployvm instance create|delete|list|verify|apps
deployvm dns nameservers
deployvm nginx ip|ssl
deployvm fastapi deploy|sync|restart|status|logs
deployvm nuxt deploy|sync|restart|status|logs

Common options:

  • --provider aws|digitalocean
  • --region <region>
  • --vm-size <size>
  • --domain <domain>
  • --no-ssl
  • --app-name <name>
  • --iam-role <name> (AWS only)

Requirements

Tool Purpose Required Install
uv Python package manager Yes curl -LsSf https://astral.sh/uv/install.sh | sh
ssh, rsync, tar, scp File transfer & remote ops Yes Pre-installed (macOS/Linux)
doctl DigitalOcean CLI Optional brew install doctl
aws AWS CLI Optional brew install awscli
npm Nuxt local builds Optional brew install node

SSH Key

Automatically uploads ~/.ssh/id_ed25519.pub, id_rsa.pub, or id_ecdsa.pub to the provider on first use.

Instance State

Metadata stored in <name>.instance.json:

{
  "id": "i-0abc123",
  "ip": "54.123.45.67",
  "provider": "aws",
  "region": "ap-southeast-2",
  "vm_size": "t3.small",
  "user": "deploy",
  "apps": [
    {"name": "api", "type": "fastapi", "port": 8000},
    {"name": "frontend", "type": "nuxt", "port": 3000}
  ]
}

Support

  • Issues: GitHub Issues
  • Help: deployvm --help or deployvm <command> --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deployvm-0.1.10.tar.gz (122.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deployvm-0.1.10-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

Details for the file deployvm-0.1.10.tar.gz.

File metadata

  • Download URL: deployvm-0.1.10.tar.gz
  • Upload date:
  • Size: 122.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.5

File hashes

Hashes for deployvm-0.1.10.tar.gz
Algorithm Hash digest
SHA256 36133458673f215d43ac2ba5b359172ef565441d790bb2a4d8dacf05c44bfad2
MD5 4c241a53c09931ebcd025071d55231d7
BLAKE2b-256 8197805c813d72fd825c2c7a177c48bfe3d53ef6ae18de08bb490d532c936dc9

See more details on using hashes here.

File details

Details for the file deployvm-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: deployvm-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 35.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.5

File hashes

Hashes for deployvm-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 e39bb71a314fe36b55d4dcd2fedaa80163dbf3b04224f7d259b4b4f06baaa047
MD5 d3e3b91a8c782d354cfe0e29efbe42ba
BLAKE2b-256 f0b5350b411d3b5e9555eb02dcf0180a3182f3741788a61d45ce7548d7f28d59

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page