Skip to main content

pluvial

Pluvial is a Python package for generating static websites from markdown files, born out of a rainy day project. The name "pluvial" was chosen as a nod to the day the project was started, which happened to be a particularly rainy day.

Local Setup

Install Miniconda

For installers for operating systems other than linux see https://docs.conda.io/en/latest/miniconda.html

curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -s --output miniconda.sh
chmod +x miniconda.sh
./miniconda.sh -u
rm miniconda.sh

Create conda enviroment

You may need to reopen your shell after installing miniconda

conda create -n pluvial python=3.10
conda activate pluvial
conda install --file requirements.txt

Run the project

The default port is 5000

python ./app/main.py

Docker

Building the Docker container

With your working directory in the root of the repository

docker build --tag pluvial .

Running the Docker container

docker run -p 5000:5000 pluvial

or for detached mode

docker run -d -p 5000:5000 pluvial    

Publishing to docker

docker login
docker build --tag mullinmax/pluvial:latest .
docker push mullinmax/pluvial:latest

Metadata

Release files for pluvial 0.0.3

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

Source distribution (sdist)

Source distribution for pluvial 0.0.3
File Size Uploaded Provenance Actions
pluvial-0.0.3.tar.gz 2.5 kB Without provenance Details for pluvial-0.0.3.tar.gz

Built distribution (wheel)

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

Total release size: 4.3 kB

Release files / pluvial-0.0.3.tar.gz

Download URL pluvial-0.0.3.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
e4d805c18dc4b5cac1a541f699471e0eb32092a350950e42be65a1b1d5c048d7
BLAKE2b-256 checksum
How to use checksums
7b6823db34ffd1bc030db6fac5332fbeb4426d8799b5a9afaef83a0623fcb5bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release files / pluvial-0.0.3-py3-none-any.whl

Download URL pluvial-0.0.3-py3-none-any.whl
Size 1.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5db9923a16232fed94ea95dbb6433788180403bd5652679ca03a0902386b3379
BLAKE2b-256 checksum
How to use checksums
7af4362b3c7fe5ba02f8a5ff0057e796082ac0968686444b2087bca5e79a2c5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Security for pluvial 0.0.3

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.

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