Skip to main content

Render CLI in Python

Project description

RenderPy

🚀 A Python-based CLI for managing Render services, built with Typer, httpx, Rich, and Textual.

Features

  • ✅ List services
  • ✅ Trigger deployments
  • ✅ View deployment history
  • ✅ Tail logs with Textual TUI

Installation

pip install .
# or if uploaded to PyPI
pip install renderpy

Usage Guide

Getting Started
Before using the CLI, you must authenticate with your Render API key.

Logging In
To save your API key, run the login command. You will be prompted to enter your key, which the CLI will then securely save to a file.

renderpy login
🔑 Enter Your Render API key:**************
API key saved sucessfully

After successfully saving the key, you will see a confirmation message.

Available Commands
The RenderPy CLI provides several commands to interact with your Render services.

Services
These commands help you manage your Render services.

  • renderpy services list
    Lists all your Render services in a formatted table, showing the ID, name, type, and status of each.
  • renderpy services info <service_id>
    Displays a quick summary for a specific service ID.
  • renderpy services get <service_id>
    Displays detailed information for a specific service ID in a formatted table. Use the --json flag to get the raw JSON output instead.
    Example:
    renderpy services get srv-123abc456def789ghi
    
    Example with JSON output:
    renderpy services get srv-123abc456def789ghi --json
    

Deployments
Use these commands to manage deployments for your services.

  • renderpy deploy create <service_id>
    Triggers a new deployment for the specified service. By default, it uses the main branch. You can specify a different branch with --branch and clear the build cache with --clear-cache.

    Example:

    renderpy deploy create srv-123abc456def789ghi --branch develop --clear-cache
    
  • renderpy deploy list <service_id>
    Lists all deployments for a given service ID, showing the deployment ID, status, and creation timestamp.

Logs
This command allows you to view the logs for your services in a Textual TUI.

  • renderpy logs stream <service_id>
    Streams live logs for a service in real-time. This command replaces the older --tail functionality and provides an interactive TUI. Press Ctrl+C to stop the log stream.
    Example:
    renderpy logs stream srv-123abc456def789ghi
    

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

renderpy-1.0.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

renderpy-1.0.0-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file renderpy-1.0.0.tar.gz.

File metadata

  • Download URL: renderpy-1.0.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for renderpy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 745ed6600234e399c4ff5ada812a6d9cad90a1dc62fc5a48fd632a700f8c802e
MD5 4b30fc81ce68fcc4e88da4876cf1778f
BLAKE2b-256 97e78315357260146ed159128c0171a567979179739c6a4644a3892ea5d33db2

See more details on using hashes here.

File details

Details for the file renderpy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: renderpy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for renderpy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2d60c386e109f68dc20f2574c2d941ba6d379ae528f20eee3b70ef163b7974f
MD5 853faf4858b73761dc773e4c0679f0b7
BLAKE2b-256 a409136459cffb2db8f0d0f8cffe31878c2684be79a907dca35b0dae3ef6c8d2

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