pegasus-cli 0.12

CLI for Django and SaaS Pegasus

pegasus-cli

Demo

A demo is worth 1,000 words. Click the image below to see the Pegasus CLI in action:

Overview

The Pegasus CLI is a command-line tool that streamlines the process of working in a Django project. It is currently designed to work with the SaaS Pegasus Django boilerplate, but can be used more generally for any Django project (and will be updated to work with generic Django projects in the future).

It is currently geared around the startapp command. This will create a new app in your Django project, and (optionally) spin up an entire Create / Update / Delete (CRUD) interface for it, built with Django forms and HTMX.

Example usage:

pegasus startapp todos Project Todo

This will create a todos app in your Django project with models, URLs, views and templates to work with a Project and Todo model.

Installation

Install this tool using pip:

pip install pegasus-cli

Usage

For help, run:

pegasus --help

You can also use:

python -m pegasus --help

Configuration

You can run pegasus startapp --help for configuration options. In addition to the command-line options, you can also set default values for configuration options by creating a pegasus-config.yaml file in your project directory. The format of the file is:

cli:
  app_directory: apps
  module_path: apps
  template_directory: templates
  base_model: apps.teams.models.BaseTeamModel
  use_teams: true

The above configuration is the recommended configuration for SaaS Pegasus projects (with teams turned on, else set use_teams: false and base_model: apps.utils.models.BaseModel).

A recommended default configuration for your project will be included in your project's pegasus-config.yaml file if you are on Pegasus version 2024.9 or later.

The Pegasus config will create your apps in the apps directory, and will use the templates directory for your templates.

Pushing to GitHub

You can use the CLI to push your Pegasus project to GitHub directly from the command line.

Setup

First, authenticate with your Pegasus API key:

pegasus auth

This will prompt for your API key and save it to ~/.pegasus/credentials. You can also set the PEGASUS_API_KEY environment variable instead.

Listing projects

To see your available projects:

pegasus projects list

Pushing to GitHub

To push a project to GitHub by ID:

pegasus projects push <project_id>

If you don't specify a project ID, you'll be prompted to choose from your projects:

pegasus projects push

To upgrade to the latest Pegasus version before pushing:

pegasus projects push <project_id> --upgrade

To upgrade to the latest development build instead of the stable release:

pegasus projects push <project_id> --upgrade --dev

The CLI will show progress as the build runs and print the pull request or repository URL when complete.

Custom server URL

By default, commands use https://www.saaspegasus.com. To use a different server, pass --base-url or set PEGASUS_BASE_URL:

pegasus projects --base-url https://your-server.com list

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd cli
python -m venv venv
source venv/bin/activate

Now install the dependencies and dev dependencies:

pip install -e '.[dev]'

To run the tests:

pytest

Setup pre-commit hooks:

pre-commit install