Skip to main content

A simple journal for use at home by the family

Project description

Home Journal

A self-hosted mini journaling site for families for capturing

  • memories
  • stories
  • photos
  • ideas
  • jokes
  • and anything else you want to remember

I had an old wordpress blog that I converted to markdown files and needed a way to view the posts. I was looking for something self-hosted and simple. Some of my design requirements were:

  • Mobile friendly and easy to post from mobile
  • Need to look and feel like a mobile app
  • Needed to be all static files, or as close as I could get
  • Needed to be markdown based
  • Needed to have a sane directory structure
  • No authentication or social auth since this is self-hosted
  • No database
  • No javascript frameworks
  • Minimal dependencies
  • No need to edit posts from the UI
  • No need to delete posts from the UI
  • Ability to regenerate all html files
  • Ability to add new posts with a text editor

What's working

  • Index page
  • Post page
  • New post page
  • Tags page
  • Progressive web app (PWA) support (requires https)
  • PWA as share target
  • Responsive design
  • Rebuild static html files (http://your.server/all)
  • Static files for all but new entry submission
  • Github style markdown formatting
  • Video uploads
  • Splitting Google motion photos into stills and video

Future enhancements

  • ¯\_(ツ)\_/¯

Installation

  • Clone the repo
  • Copy the sample_site directory to your desired location, it will be the directory for all content
  • Build and source a virtual environment
  • Install from the source directory pip install .
  • Run the server `home-journal -sd /your/site/root --tags cars,people,boats,nature
  • Enjoy (http://your.server:8000)

Thank you

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

home_journal-0.0.4.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

home_journal-0.0.4-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file home_journal-0.0.4.tar.gz.

File metadata

  • Download URL: home_journal-0.0.4.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for home_journal-0.0.4.tar.gz
Algorithm Hash digest
SHA256 101167adb73cf738aba829f38cbfe4a234dfd0995c0b1c6144a0896fed34c794
MD5 bfbb3bebfae696870d4da8b0bb50f35f
BLAKE2b-256 fc2b82b713ac8bd1c024d89af4f701a494c3fa1063f04b21a096bc79f8f1cb3a

See more details on using hashes here.

File details

Details for the file home_journal-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for home_journal-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4dc3dc30184f6bc4ed6982e9a9df48d83e12c34c98075e0070b2b5418846a5cf
MD5 a0b0c1dce979221754d4122745fdcfb6
BLAKE2b-256 042d1c20fe280b839517719e54ede3c6c6e1cbdb9fcf076965dc5eb15bc4ad0f

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