Forked from Meleneth that forked from me
Go to file
Gustavo Henrique Miranda b1e83aabbb
Merge pull request #18 from gmbrax/feat/XDG-Compliance
Applying the XDG Compliance Branch to the Stagin Branch
2025-07-05 09:23:52 -03:00
.github Update dependabot.yml 2025-06-04 00:43:03 -03:00
src/pilgrim Changed the base directory where the data generated by the program to be at the home directory and also added a check to ensure the creation of the program directory 2025-07-05 07:29:09 -03:00
.gitignore Merge branch 'development' into feat/photo-sidebar-tui 2025-06-29 22:26:10 -03:00
LICENSE Initial commit 2025-05-31 01:35:43 +00:00
README.md 📝 docs: update README with project overview, features, requirements, installation, and usage instructions 2025-06-16 12:31:05 -03:00
pyproject.toml Revert "♻️ refactor: remove unnecessary blank lines and adjust package path in pyproject.toml" 2025-06-25 22:30:18 -03:00
requirements.txt Merge pull request #5 from gmbrax/feat-TUI 2025-06-25 04:06:01 -03:00

README.md

Python_Pilgrim

Overview

Python_Pilgrim is a Python-based travel diary application designed to help users document and manage their travel experiences. The project provides tools for recording trips, organizing travel notes, and storing memories in a structured and accessible format.

Features

  • Create and manage travel diaries
  • Add, edit, and delete travel entries
  • Organize trips by date, location, or theme
  • Store photos, notes, and other media
  • Export and share travel logs

Requirements

  • Python 3.8 or higher
  • Linux operating system (tested on Ubuntu 20.04+)
  • Visual Studio Code (VSCode) for development (optional but strongly recommended)
  • pip (Python package installer)
  • Optional: virtualenv for isolated environments

Installation

  1. Clone the repository:
    git clone https://github.com/gmbrax/Pilgrim.git
    
  2. Navigate to the project directory:
    cd Pilgrim
    
  3. Create a virtual environment and, then, activate it:
    python -m venv .venv
    source .venv/bin/activate
    
  4. Install the required dependencies:
    pip install -r requirements.txt
    

Usage

To run the main application, execute:

python <???>.py

This will start the Python_Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.