Metadata-Version: 2.1
Name: Lifelog
Version: 1.0.0
Summary: A simple and secure diary app
Home-page: https://github.com/MrBeam89/lifelog/
Download-URL: https://pypi.org/project/Lifelog/
Author: MrBeam89_
Author-email: mrbeam89@protonmail.com
Maintainer: MrBeam89_
Maintainer-email: mrbeam89@protonmail.com
License: GPLv3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: X11 Applications :: GTK
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Office/Business :: News/Diary
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pycryptodomex
Requires-Dist: pygobject
Requires-Dist: scrypt
Provides-Extra: dev
Requires-Dist: twine ; extra == 'dev'

<p align="center">
  <img src="docs/images/icon_128.png" />
  <h1 align="center">Lifelog</h1>
</p>

<!-- Badges -->
<p align="center">
  <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/MrBeam89/lifelog?logo=python">
  <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/Lifelog">
  <br />
  <img alt="PyPI - Status" src="https://img.shields.io/pypi/status/Lifelog">
  <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/Lifelog">
  <br />
  <img alt="GitHub License" src="https://img.shields.io/github/license/MrBeam89/lifelog">
  <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/MrBeam89/lifelog">
  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/MrBeam89/lifelog?style=flat">
</p>

<!-- Screenshot and description-->
<p align="center">A simple and secure diary app using <b>Python</b>, <b>SQLite</b> and <b>GTK</b>.</p>

<p align="center"><img src="docs/images/screenshot_main_lorem.png" alt="Lifelog main window screenshot (Greybird-dark and elementary Xfce dark)"></p>

<!-- Table of contents -->
<p align="center">
    <a href="#installation">Installation</a>
    ·
    <a href="#usage">Usage</a>
    ·
    <a href="#features">Features</a>
    ·
    <a href="#contribute">Contribute</a>
    ·
    <a href="#license">License</a>
</p>

<!-- Installation -->
<h2 id="installation">Installation</h2>

1. Install the dependencies :

- For **Ubuntu/Debian-based distributions**
    ```
    sudo apt install python3 python3-pip cmake libcairo2-dev gobject-introspection libgirepository-1.0-dev
    ```

2. (*Optional*) Set up a virtual environment :
    ```
    python3 -m venv myenv
    source myenv/bin/activate
    ```

3. Install Lifelog from PyPI :
    ```
    pip3 install lifelog
    ```

4. **OR** install Lifelog from source:
    ```
    git clone https://github.com/MrBeam89/lifelog.git
    cd lifelog
    python3 setup.py bdist_wheel sdist
    pip install .
    ```

<!-- Usage -->
<h2 id="usage">Usage</h2>

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.

4. **:tada: You can now start writing ! :tada:**

<!-- Features -->
<h2 id="features">Features</h2>

- **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 -->
<h2 id="contribute">Contribute</h2>

See [CONTRIBUTING.md](CONTRIBUTING.md).

<!-- License -->
<h2 id="license">License</h2>

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.
