Skip to content

Latest commit

 

History

History
109 lines (86 loc) · 3.65 KB

README.md

File metadata and controls

109 lines (86 loc) · 3.65 KB
Raw

Lifelog

GitHub top language PyPI - Python Version
PyPI - Status PyPI - Downloads
GitHub License GitHub pull requests GitHub Repo stars

A simple and secure diary app using Python, SQLite and GTK.

Lifelog main window screenshot (Greybird-dark and elementary Xfce dark)

Installation · Usage · Features · Contribute · License

Installation

  1. Install the dependencies :
  • For Ubuntu/Debian-based distributions 
    sudo apt install python3 python3-pip cmake libcairo2-dev gobject-introspection libgirepository-1.0-dev

  1. (Optional) Set up a virtual environment :

    python3 -m venv myenv
source myenv/bin/activate

  2. Install Lifelog from PyPI :

    pip3 install lifelog

  3. OR install Lifelog from source:

    git clone https://github.com/MrBeam89/lifelog.git
cd lifelog
python3 setup.py bdist_wheel sdist
pip install .

Usage

  1. Start Lifelog with the following commands : lifelog or python3 -m lifelog

  2. Create a diary or open an existing one :

    • Click on the New File icon (at the top left) or Ctrl+N
    • OR Click on the Open File icon or Ctrl+O

  3. Set a password (minimum length : 8 characters) or type the existing one.

Warning

If you forget your password, you will be unable to retrieve your lost data.

  1. 🎉 You can now start writing ! 🎉

Features

  • Simple and intuitive interface : Designed with simplicity in mind.
  • Title and tags : Make searching for specific entries easier.
  • Mood tracking : Scale from 1 to 100.
  • Rich text : Bold/italic/underline/strikethrough text, and paragraph alignment.
  • Image support : Supports the following formats (by default) : JPEG, PNG, ICO and BMP.
  • Encryption : Uses AES-256 along with scrypt to protect your data.
  • Searching : Find specific entries between two dates by their titles or their tags.

Contribute

See CONTRIBUTING.md.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.