Skip to main content

Bootstrap a new Plain project from starter templates

Project description

Plain Start

Bootstrap a new Plain project from official starter templates.

Overview

The plain-start command provides a streamlined way to create new Plain projects from official starter templates. It clones the starter repository, configures your project name, and optionally runs the installation script to get you up and running quickly.

Basic usage:

uvx plain-start my-project

This creates a new project called my-project using the full app starter template (with ORM, auth, admin, etc.).

Starter types

Plain provides two official starter templates:

App starter (default)

The app starter includes a full-featured setup with:

  • Database ORM
  • Authentication system
  • Admin interface
  • Session management
  • All core Plain packages

Create an app starter project:

uvx plain-start my-app
# or explicitly:
uvx plain-start my-app --type app

Bare starter

The bare starter is a minimal setup with:

  • Plain framework core
  • Development tools only
  • No database or auth by default

Create a bare starter project:

uvx plain-start my-project --type bare

Options

The cli command accepts the following options:

--type

Choose between app (default) or bare starter templates.

uvx plain-start my-project --type bare

--no-install

Skip running the ./scripts/install script after cloning. Useful if you want to review the project structure before installing dependencies.

uvx plain-start my-project --no-install

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

plain_start-0.1.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

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

plain_start-0.1.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file plain_start-0.1.0.tar.gz.

File metadata

  • Download URL: plain_start-0.1.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for plain_start-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9132bf40be24f23c6f7b452d26158f275ae7e218c5d496067cf0bd4d13739486
MD5 78a09307306443eea48bbc76184981ac
BLAKE2b-256 800fe486901b757d22a3f1f8953398698d98a9a18462cbb3b15caa192dad31d9

See more details on using hashes here.

File details

Details for the file plain_start-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: plain_start-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for plain_start-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d91521086f3b3fb309aa4b2c1c316bb7b0e49b08875661a872cc46d28bf113d
MD5 08e4b04ae8d5a019c6acbc6bfe3e50e1
BLAKE2b-256 06e10238dcef258cc3d5996b2d3b3f30efdfc371e0b6f1fa169c4f9b24333f0f

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