Skip to content

Webapp to serve rich content from a journal in plaintext format.

License

Notifications You must be signed in to change notification settings

TheCDC/journal_app

Repository files navigation

Description

This is a simple webapp for extracting rich content from a journal stored as a text file in the following format:

2000-1-1
This is an example of the formatting of the journal.

2000-1-2
Each entry is simply a date header on its own line in the form of YYYY-MM-DD.
Anything after a date header but before the next one (or the end of the file) is the body of the entry.

2000-1-3
The application supports plugins written in Python.
One plugin included as an example can link journal entries together by identifying dates within the contents of entries.

The first entry of this journal occurred on 2000-1-1.

Yesterday and tomorrow are also dates.

Screenshots

Screenshot-2018-7-2_Journal_App(5).png


Screenshot-2018-7-2_Journal_App(4).png


Screenshot-2018-7-2_Journal_App(3).png


Screenshot-2018-7-2_Journal_App(6).png


Getting Started

This project requires Python 3.

Dependencies

You will need the pipenv package manager.

Installation

Install pipenv with pip3 install --user pipenv.

From the repo root execute pipenv install to instantiate a virtual environment and install all dependencies.

Starting it up

To start the application with one command execute use pipenv run python -m webapp or pipenv run flask run.

This project is distributed as a python package and can also be executed directly with python -m webapp.

The app will be served on 127.0.0.1:5000.

About

Webapp to serve rich content from a journal in plaintext format.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published