Skip to main content

Build

Travis-CI Build Status codecov

Package

PyPI Package latest release PyPI Wheel Supported versions Supported implementations

Dev tools for Sanic.

This tool is highly inspired by aiohttp-devtools, aio-libs.

Installation

pip install sanic-devtools

Quick Start

⋊> ~ sdev --help

Usage: sdev [OPTIONS] COMMAND [ARGS]...

Options:
  -V, --version  Show the version and exit.
  --help         Show this message and exit.

Commands:
  new        Creates a new sanic project with batteries included.
  runserver  Run a development server for an Sanic app.

Usage

sanic-devtools provides several commands to help you develop Sanic Application easily.

runserver

Provides a simple local server for running your application while you’re developing, it helps you live reload your Sanic application automatically while developing and having any code change.

sdev runserver <app-path>

app-path can be a path to either a directory containing a recognized default file (app.py or main.py) or to a specific file. The --app-factory option can be used to define which method is called from the app path file, if not supplied some default method names are tried (app/app_factory/get_app/create_app).

All runserver arguments can be set via environment variables.

For more details, try:

sdev runserver --help

new

Creates a new sanic project with batteries included in seconds.

sdev new --output-dir <project-output-path>

By default, sdev uses cookiecutter-sanic as default template under the hood. You may override it by passing --template-src option.

For more details, try:

sdev new --help

Also feel free to add any tool/command that helps developing Sanic application smoothly, just create a PR/issue and let us know !

Contributing

sanic-devtools accepts contributions on GitHub, in the form of issues or pull requests.

Run unit tests.

tox -e py36

or

./uranium test

Test command locally.

./uranium
./bin/sdev runserver ./example/app.py

Metadata

Release files for sanic-devtools 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sanic-devtools 0.1.0
File Size Uploaded
sanic-devtools-0.1.0.tar.gz 16.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sanic-devtools 0.1.0
File Interpreter ABI Platform
sanic_devtools-0.1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 37.1 kB

Release files / sanic-devtools-0.1.0.tar.gz

Download URL sanic-devtools-0.1.0.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
edabe133c551257a86434b5aaa67b45bd260c7fdba086ce46f352314961d5b39
BLAKE2b-256 checksum
How to use checksums
6c19130815d88f6de270f13979d3af0f29868e290ea3cbb3fb5cf4b3d81c8372
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

Release files / sanic_devtools-0.1.0-py2.py3-none-any.whl

Download URL sanic_devtools-0.1.0-py2.py3-none-any.whl
Size 20.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
270c5394d94f4c4c64711fa931a31431e1bca9e067a564fd025cc66d563ac25a
BLAKE2b-256 checksum
How to use checksums
77cb8e02090cfd85730f159991d241fd7d9ef276da5a57cc76184a31b1209959
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page