mirror of https://github.com/gmbrax/Pilgrim.git
Compare commits
13 Commits
f42d15048c
...
de0e415ee2
| Author | SHA1 | Date |
|---|---|---|
|
|
de0e415ee2 | |
|
|
4f1740f575 | |
|
|
cc723bdbbb | |
|
|
b73c4e12c8 | |
|
|
cc7f0ec53d | |
|
|
3620889e71 | |
|
|
8de20547c2 | |
|
|
57614755d5 | |
|
|
e503a57051 | |
|
|
6af035c050 | |
|
|
11345203e5 | |
|
|
543916a1a1 | |
|
|
483c4b8529 |
|
|
@ -0,0 +1,41 @@
|
||||||
|
# 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,16 +1,17 @@
|
||||||
# Python_Pilgrim
|
# Pilgrim
|
||||||
|
|
||||||
## Overview
|
## 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.
|
**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
|
## 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, notes, and other media
|
- Store photos and add them to the diary entry
|
||||||
- Export and share travel logs
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
- Python 3.8 or higher
|
- Python 3.8 or higher
|
||||||
|
|
@ -21,30 +22,25 @@
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Clone the repository:
|
To install the application you must issue the command:
|
||||||
```bash
|
|
||||||
git clone https://github.com/gmbrax/Pilgrim.git
|
```bash
|
||||||
```
|
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 run the main application, execute:
|
To use application you just issue:
|
||||||
|
```bash
|
||||||
```bash
|
pilgrim
|
||||||
python <???>.py
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This will start the Python_Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
|
This will start the 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.1"
|
version = "0.0.3"
|
||||||
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.0
|
typing_extensions==4.14.1
|
||||||
|
|
||||||
|
|
||||||
textual~=3.3.0
|
textual~=3.6.0
|
||||||
|
|
|
||||||
|
|
@ -1027,4 +1027,13 @@ 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