Skip to main content

Cascading, Highly Irrelevant, Lost Llamas

Or, just chill. This is a database driven web application framework in Flask and it can be used to create static or dynamic web sites.

This involves creating custom SQL queries to pull data from a database and uses Jinja2 HTML templates to populate pages for a website. Chill can create static files for the website or can run as a Flask app and build pages on request.

Chill is database driven when it comes to handling http requests. Each http request uses data from the database when determining what content to show on the page as well as what HTML templates to use. Content for a page can come from other database queries and can recursively call other queries when populating the page.

Installing

Chill can be installed via pip.

python3 -m pip install chill[cli]

Or from within this cloned project; install with pip in editable mode. It is recommended to setup a virtual environment first.

# Create a python virtual environment in the project directory and activate it.
python3 -m venv .
source ./bin/activate

# Install chill in editable mode
python -m pip install -e .[cli,test]

This will create a script called chill. Type chill --help for help on using it. It will need a config file and such. I recommend creating an empty directory and running chill init within it. That will create a site.cfg config file and the bare minimum to show a homepage. Run the chill run --config site.cfg and visit http://localhost:5000/ with your browser.

Quick start

Run the chill init script in an empty directory and it will create a minimal starting point for using Chill. The site.cfg created will have comments on each configuration value. The chill run --config site.cfg will run the app in the foreground at the http://localhost:5000/ URL. Notice that the script also creates a sqlite database file (default file name is 'db') in that directory. This database file is what chill uses to display the pages in a site.

Review the docs for more. Some helpful guides and such are in the docs/ folder. The tests.py file within the chill package is also a good resource.

Static site generator

The command chill freeze --config site.cfg will go through all the URLs and create a static version of each page. It places all the necessary files in a folder which can then be uploaded to a static web server. This is a wrapper around the Frozen-Flask python package. Which is partly the inspiration behind the name 'chill'. Also, llamas are cool and have two 'l's like chill.

Docker

A Dockerfile has been included which can be used when creating a container for chill. See the guide on using chill with docker.

Contributing

Please contact Jake Hickenlooper or create an issue.

Any submitted changes to this project require the commits to be signed off with the git command option '--signoff'. This ensures that the committer has the rights to submit the changes under the project's license and agrees to the Developer Certificate of Origin.

License

GNU Lesser General Public License v3.0

Maintenance

Where possible, an upkeep comment has been added to various parts of the source code. These are known areas that will require updates over time to reduce software rot. The upkeep comment follows this pattern to make it easier for commands like grep to find these comments.

Example UPKEEP comment has at least a 'due:' or 'label:' or 'interval:' value surrounded by double quotes (").

Example-> # UPKEEP due: "2022-12-14" label: "Llama Pie" interval: "+4 months"

Show only past due UPKEEP comments.

make upkeep

Metadata

Release files for chill 0.10.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 chill 0.10.0
File Size Uploaded Provenance Actions
chill-0.10.0.tar.gz 52.4 kB Without provenance Details for chill-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for chill 0.10.0
File Interpreter ABI Platform Actions
chill-0.10.0-py3-none-any.whl Python 3 none any Details for chill-0.10.0-py3-none-any.whl

Total release size: 120.8 kB

Release files / chill-0.10.0.tar.gz

Download URL chill-0.10.0.tar.gz
Size 52.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8da54085c5385580b56016134e723fe7f25f1d8db82ad9be33c10c55537c0784
BLAKE2b-256 checksum
How to use checksums
d364bc191bcbad983db0c3f45d9d99cd5f94eed0a10fe54e52d2c42668378221
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release files / chill-0.10.0-py3-none-any.whl

Download URL chill-0.10.0-py3-none-any.whl
Size 68.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a3830e55ca97fc9ac90cc888bf5de507bfaf220fa8d5bffee2f0c8a6dfb21109
BLAKE2b-256 checksum
How to use checksums
9c30f635cee6ba2109612814ec4ff95263eca53fff386979397789fbf0be03a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Security for chill 0.10.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.10.0 This release

2 release files No provenance

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