mirror of https://github.com/gmbrax/Pilgrim.git
Compare commits
No commits in common. "de0e415ee288e563d76b600cfd9789a7612cd634" and "f42d15048cfaeba5c74dd3c79239652a1b062d81" have entirely different histories.
de0e415ee2
...
f42d15048c
41
CHANGELOG.md
41
CHANGELOG.md
|
|
@ -1,41 +0,0 @@
|
||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
||||||
|
|
||||||
## [Unreleased]
|
|
||||||
|
|
||||||
### Planned
|
|
||||||
|
|
||||||
- Installation Method 1 (repository compilation)
|
|
||||||
- Organization of trips by date, location, or theme
|
|
||||||
- Enhanced photo management features
|
|
||||||
- Search functionality
|
|
||||||
- Export features
|
|
||||||
- Testing implementation
|
|
||||||
|
|
||||||
## [0.0.1] - 2025-07-06
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Initial alpha release of Pilgrim travel diary application
|
|
||||||
- Create and edit travel diaries
|
|
||||||
- Create and edit diary entries
|
|
||||||
- Photo ingestion system
|
|
||||||
- Photo addition and reference via sidebar
|
|
||||||
- Text User Interface (TUI) built with Textual framework
|
|
||||||
- Pre-compiled binary installation method (Method 2)
|
|
||||||
- Support for Linux operating systems
|
|
||||||
- Basic project documentation (README)
|
|
||||||
|
|
||||||
### Known Issues
|
|
||||||
|
|
||||||
- Installation Method 1 not yet implemented
|
|
||||||
- No testing suite implemented yet
|
|
||||||
- Some features may be unstable in alpha version
|
|
||||||
|
|
||||||
[Unreleased]: https://github.com/username/pilgrim/compare/v0.0.1...HEAD
|
|
||||||
|
|
||||||
[0.0.1]: https://github.com/username/pilgrim/releases/tag/v0.0.1
|
|
||||||
48
README.md
48
README.md
|
|
@ -1,17 +1,16 @@
|
||||||
# Pilgrim
|
# Python_Pilgrim
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
**Pilgrim** is a Python-based travel diary application designed to help users document and manage their travel
|
**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.
|
||||||
experiences. The project provides tools for recording trips, organizing travel notes, and storing memories in a
|
|
||||||
structured and accessible format.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Create and manage travel diaries
|
- Create and manage travel diaries
|
||||||
- Add, edit, and delete travel entries
|
- Add, edit, and delete travel entries
|
||||||
- Organize trips by date, location, or theme
|
- Organize trips by date, location, or theme
|
||||||
- Store photos and add them to the diary entry
|
- Store photos, notes, and other media
|
||||||
|
- Export and share travel logs
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
- Python 3.8 or higher
|
- Python 3.8 or higher
|
||||||
|
|
@ -22,25 +21,30 @@ structured and accessible format.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
To install the application you must issue the command:
|
1. Clone the repository:
|
||||||
|
```bash
|
||||||
```bash
|
git clone https://github.com/gmbrax/Pilgrim.git
|
||||||
pip install pilgrim
|
```
|
||||||
```
|
2. Navigate to the project directory:
|
||||||
|
```bash
|
||||||
|
cd Pilgrim
|
||||||
|
```
|
||||||
|
3. Create a virtual environment and, then, activate it:
|
||||||
|
```bash
|
||||||
|
python -m venv .venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
```
|
||||||
|
4. Install the required dependencies:
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
To use application you just issue:
|
To run the main application, execute:
|
||||||
```bash
|
|
||||||
pilgrim
|
```bash
|
||||||
|
python <???>.py
|
||||||
```
|
```
|
||||||
|
|
||||||
This will start the Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
|
This will start the Python_Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
|
||||||
|
|
||||||
## Changelog
|
|
||||||
|
|
||||||
To see all the changes in the current version, please refer to the [CHANGELOG](CHANGELOG.md)
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
This project is licensed under the BSD 3-Clause License — see the [LICENSE](LICENSE) file for details.
|
|
||||||
|
|
@ -5,7 +5,7 @@
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "Pilgrim"
|
name = "Pilgrim"
|
||||||
version = "0.0.3"
|
version = "0.0.1"
|
||||||
authors = [
|
authors = [
|
||||||
{ name="Gustavo Henrique Santos Souza de Miranda", email="gustavohssmiranda@gmail.com" }
|
{ name="Gustavo Henrique Santos Souza de Miranda", email="gustavohssmiranda@gmail.com" }
|
||||||
]
|
]
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
greenlet==3.2.3
|
greenlet==3.2.3
|
||||||
SQLAlchemy==2.0.41
|
SQLAlchemy==2.0.41
|
||||||
typing_extensions==4.14.1
|
typing_extensions==4.14.0
|
||||||
|
|
||||||
|
|
||||||
textual~=3.6.0
|
textual~=3.3.0
|
||||||
|
|
|
||||||
|
|
@ -1027,13 +1027,4 @@ class EditEntryScreen(Screen):
|
||||||
# Tab: insert tab
|
# Tab: insert tab
|
||||||
elif self.focused is self.text_entry and event.key == "tab":
|
elif self.focused is self.text_entry and event.key == "tab":
|
||||||
self.text_entry.insert('\t')
|
self.text_entry.insert('\t')
|
||||||
event.stop()
|
event.stop()
|
||||||
|
|
||||||
def on_footer_action(self, event) -> None:
|
|
||||||
"""Handle clicks on footer actions (Textual 3.x)."""
|
|
||||||
action = event.action
|
|
||||||
method = getattr(self, f"action_{action}", None)
|
|
||||||
if method:
|
|
||||||
method()
|
|
||||||
else:
|
|
||||||
self.notify(f"No action found for: {action}", severity="warning")
|
|
||||||
Loading…
Reference in New Issue