Skip to main content

A minimalist note engine

Project description

A minimalist note engine

  • ~500 lines of code

  • no javascript

  • usable on any browser, including on mobile

  • no database, just a bare git repo for storage and sync

  • http basic auth

  • pages are markdown files in the git repo. earch “directory” must have an index.md at the top

  • title of each page is the top line of the markdown file

  • sub-pages are sorted alphabetically

  • edition is a text area containing the markdown

Usage

zpov is a python application built using flask. refer to the flask documentation to learn about developement and/or debugging.

note that you will need a config file named zpov.yml in the current directory, looking like this

public_access: <true|false>

users:  # required if public_access is ``false``
  <user>: "<hashed password>"

repo_path: 'path/to/repo.git

where:

  • path/to/repo.git is a bare git repository containing the markdown files.

  • hashed_password was generated with nacl.pwhash.str('<password>').

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

zpov-1.0.1.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

zpov-1.0.1-py3-none-any.whl (1.7 kB view hashes)

Uploaded Python 3

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