Skip to main content

Single-page application server for end-to-end testing.

Project description

Unix: Unix Build Status Windows: Windows Build StatusMetrics: Coverage Status Scrutinizer Code QualityUsage: PyPI Version PyPI Downloads

Overview

Sappy is a simple, single-page application (SPA) web server for end-to-end testing.

The Python standard library includes a web server that works great for serving up files:

$ python3 -m http.server 8080
Serving HTTP on 0.0.0.0 port 8080 ...

$ curl http://localhost:1234/index.html
<!DOCTYPE html>
<html>
  <head>
    <title>Example Index</title>
...

But when used to serve up single-page applications, a 404 is returned whenever any page other than the index is accessed directly:

$ curl http://localhost:8080/login
<!DOCTYPE html>
<html lang=en>
  <title>Error 404 (Not Found)</title
...

This project builds on the existing web server code to forward all requests to the index. The single-page application’s client-side routing can then display the page that corresponds to that request’s URL.

Setup

Requirements

  • Python 3.5+

Installation

Install sappy with pip:

$ pip install sappy

or directly from the source code:

$ git clone https://github.com/jacebrowning/sappy.git
$ cd sappy
$ python setup.py install

Usage

Build your static website (e.g. an Ember application) for production:

$ ember build --environment=production
Building...
Built project successfully. Stored in "dist/".

Then serve up the application:

$ sappy
Serving /home/browning/project/dist/ on 8080

Check out the documentation or command-line help for additional options:

$ sappy --help

Revision History

1.0.1 (2017/03/21)

  • Fixed handling of relative paths in assets.

1.0 (2017/01/09)

  • Initial stable release.

0.2 (2016/06/09)

  • Added a --launch option to open the page’s index.

0.1 (2016/06/09)

  • Initial release.

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

sappy-1.0.1.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

sappy-1.0.1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file sappy-1.0.1.tar.gz.

File metadata

  • Download URL: sappy-1.0.1.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sappy-1.0.1.tar.gz
Algorithm Hash digest
SHA256 677f278f79b5c3b0b0eb279c975790aca6f10c4bb6d710214893bad3e2e6659c
MD5 5824b730fca8da658c17bd27540a8eab
BLAKE2b-256 0d11cee29a74b6a4d2e559134f823889123894d40492de7d860c1846b923ad73

See more details on using hashes here.

File details

Details for the file sappy-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sappy-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80503db9940ea723af622bf51e5dff615625850d82f70924ce6255b9fbd62cd8
MD5 8f8f36b61fac13efd17cf27ab506e8d2
BLAKE2b-256 ababddb0bfdbc4dc27d9759edafeb8e811a7b757a55f427d41961bcec710dc22

See more details on using hashes here.

Supported by

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