Distribusi is a content management system for the web that produces static pages based on the file system.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Luke Murphy 9b8be7c761
Show how to upgrade
1 month ago
distribusi Clean up imports and formatting 1 month ago
scripts Package it up! Get it in shape for PyPi. 9 months ago
.gitignore Ignore new Pip related files 1 month ago
CHANGELOG.md Add changelog 1 month ago
LICENSE Package it up! Get it in shape for PyPi. 9 months ago
Makefile Don't use pipenv for releases 1 month ago
README.md Show how to upgrade 1 month ago
TODO.md Package it up! Get it in shape for PyPi. 9 months ago
pyproject.toml Add Black and Pip files config 1 month ago
setup.py Bump to the next version and pin python-magic 1 month ago

README.md

Distribusi CMS

PyPI version

distribusi is a content management system for the web that produces static index pages based on folders in the filesystem. It is inspired by the automatic index functions featured in several web servers. It works by traversing the file system and directory hierarchy to automatically list all the files in the directory and providing them with html classes and tags for easy styling.

Requirements

While a Pip install will pull in Python dependencies, you might need system dependencies. This package requires two underlying packages. Those are python-magic, and pillow. Here are the installation documentation for those packages:

Install It

$ export PATH=$PATH:$HOME/.local/bin
$ pip install --user distribusi

Upgrade It

If you already have it, you can upgrade with:

$ pip install -U distribusi

Use It

Get help with:

$ distribusi --help

Make a distribusi of your home folder:

$ distribusi -d ~/

You will find that you now have an index.html in every folder.

Create a quick gallery for the web:

$ distribusi -d /path/to/my/photos -t

This creates an index.html with base64 encoded thumbnails.

Generate verbose output:

$ distribusi -v

Make an index of the archive page:

$ distribusi -d /var/www/archive/my_event -t -v

Change It

You’ll need to get a copy of the repository and then do an editable install:

$ git clone https://git.vvvvvvaria.org/varia/distribusi.git && cd distribusi
$ python3 -m venv .venv && source .venv/bin/activate
$ pip install -e .

You’re then ready to make your changes and experiment with them.

Release It

You’ll need a PyPi account and to be added as a maintainer.

Please ask around @ Varia for who has PyPi access.

$ pip install twine
$ make publish