Skip to main content

The tools that power the canopy

Project description

understory

Tools to power your personal website

An IndieWeb-compatible personal website packaged and deployed

Install Poetry.

Clone your empty website repository and descend into it. If you use a private GitHub repository your changes will be deployed through GitHub. If you use a public repository your changes will be deployed through PyPI.

Initialize your project and add understory as a dependency.

poetry init
poetry add understory

Create a file site.py:

from understory import indieweb

app = indieweb.site()

Add your site's app as an entry point in your pyproject.toml:

poetry run web install site:app AliceAnderson

Serve your website locally in development mode:

poetry run web serve AliceAnderson

Open localhost:9000 in your browser.

Develop. For example, add a custom route:

import random

@app.route(r"hello")
class SayHello:
    return random.choice(["How you doin'?", "What's happening?", "What's up?"])

To publish:

poetry run pkg publish patch

To deploy:

poetry run web deploy

██╗   ██╗███╗   ██╗██████╗ ███████╗██████╗ ███████╗████████╗ ██████╗ ██████╗ ██╗   ██╗
██║   ██║████╗  ██║██╔══██╗██╔════╝██╔══██╗██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗╚██╗ ██╔╝
██║   ██║██╔██╗ ██║██║  ██║█████╗  ██████╔╝███████╗   ██║   ██║   ██║██████╔╝ ╚████╔╝
██║   ██║██║╚██╗██║██║  ██║██╔══╝  ██╔══██╗╚════██║   ██║   ██║   ██║██╔══██╗  ╚██╔╝
╚██████╔╝██║ ╚████║██████╔╝███████╗██║  ██║███████║   ██║   ╚██████╔╝██║  ██║   ██║
 ╚═════╝ ╚═╝  ╚═══╝╚═════╝ ╚══════╝╚═╝  ╚═╝╚══════╝   ╚═╝    ╚═════╝ ╚═╝  ╚═╝   ╚═╝

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

understory-0.0.44.tar.gz (500.1 kB view details)

Uploaded Source

Built Distribution

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

understory-0.0.44-py3-none-any.whl (530.8 kB view details)

Uploaded Python 3

File details

Details for the file understory-0.0.44.tar.gz.

File metadata

  • Download URL: understory-0.0.44.tar.gz
  • Upload date:
  • Size: 500.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.1 Linux/4.19.0-17-amd64

File hashes

Hashes for understory-0.0.44.tar.gz
Algorithm Hash digest
SHA256 b467bb6783f76b301db847a7ec5b64a7fcbc2a04347e48c67eaca87aef15121b
MD5 e3999f5091b5f22bfd1fc22f4a4e4f1e
BLAKE2b-256 5d2dcfdb0407c967ce65753bdafd3d10f508b8f57f61cb535d9ee8023b331bb1

See more details on using hashes here.

File details

Details for the file understory-0.0.44-py3-none-any.whl.

File metadata

  • Download URL: understory-0.0.44-py3-none-any.whl
  • Upload date:
  • Size: 530.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.1 Linux/4.19.0-17-amd64

File hashes

Hashes for understory-0.0.44-py3-none-any.whl
Algorithm Hash digest
SHA256 3ae971ad74802a3d1fd2dfe84afabe00c0ba1ae5e90dba3b8f0a48cc9fac5ca8
MD5 20196ce8c436aad7345e6e66a02f6af2
BLAKE2b-256 4aa6844f957859aa1fc7f668059dd1b4eb2ac43e5c9e1ae702654ae771b45f5c

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