# HoraLog_CLI
A simple, terminal-based journal application that logs sentences with timestamps into per-day YAML files.
## Features
- **Journal Mode**: Type entries with automatic timestamps
- **Review Mode**: Browse and view past journal entries
- **Minimal Dependencies**: Only requires `pyyaml`
- **Termux Optimized**: Perfect for Android Termux
- **Simple & Fast**: Does one thing well with minimal clutter
## Installation
### Standard Installation
```bash
# Install from PyPI (when published)
pip install horalog-cli
# Or install from local directory
pip install -e .
```
### Android Termux Installation
```bash
# Install Python and pip if not already installed
pkg install python
# Install pyyaml
pip install pyyaml
# Clone or download the project
git clone <repository-url>
cd HoraLog_CLI
# Install in development mode
pip install -e .
```
## Usage
### Journal Mode (Default)
Start the application to begin journaling:
```bash
horalog-cli
```
This will:
- Create a `journal/` folder if it doesn't exist
- Load today's existing entries
- Show a prompt like `[14:30:25] > `
- Save each entry immediately when you press Enter
- Keep previous entries visible while typing
### Review Mode
Browse past journal entries:
```bash
horalog-cli --review
# or
horalog-cli -r
```
This will show a numbered list of available dates and let you select one to view.
### View Specific Date
View entries for a specific date:
```bash
horalog-cli --date 2025-01-15
```
## Example Output
### Journal Mode
```
HoraLog_CLI - Journal Mode
Today: 2025-01-17
Previous entries for today:
[07:45:30] Early start to test the new features
[09:30:15] Testing journal mode - everything looks good
[10:15:45] Testing review mode - navigation works perfectly
Type your journal entries (Ctrl+C to exit):
[12:00:00] > Working on documentation
[12:00:00] Working on documentation
[14:30:20] > Final testing and bug fixes
[14:30:20] Final testing and bug fixes
```
### Review Mode
```
HoraLog_CLI - Review Mode
Available journal files:
1. 2025-01-17 (6 entries)
2. 2025-01-16 (6 entries)
3. 2025-01-15 (5 entries)
Enter number (1-3) or date (YYYY-MM-DD): 2
Entries for 2025-01-16:
[08:30:15] Morning routine - coffee and planning
[09:00:00] Started debugging the timestamp issue
[11:20:45] Fixed the bug, now timestamps are working correctly
[13:15:20] Team standup meeting
[15:30:10] Working on the review mode functionality
[17:00:00] Completed the review mode, ready for testing
Press Enter to return to menu or Ctrl+C to exit
```
## File Structure
Journal entries are stored in YAML files:
```
journal/
├── 2025-01-15.yaml
├── 2025-01-16.yaml
└── 2025-01-17.yaml
```
Each YAML file contains:
```yaml
entries:
- time: "09:15:22"
text: "Started working on the new project design"
- time: "10:30:45"
text: "Had a productive meeting with the team"
```
## Commands
- `horalog-cli` - Start journal mode (default)
- `horalog-cli --review` or `horalog-cli -r` - Start review mode
- `horalog-cli --date YYYY-MM-DD` - View specific date
- `horalog-cli --help` - Show help
- `horalog-cli --version` - Show version
## Requirements
- Python 3.8+
- pyyaml>=6.0
## Development
### Quick Start
```bash
# Clone the repository
git clone <repository-url>
cd HoraLog_CLI
# Install development dependencies
make install-dev
# Install package in development mode
make install
# Run tests
make test
# Build distribution
make build
```
### Available Commands
```bash
make help # Show all available commands
make install # Install package in development mode
make install-dev # Install development dependencies
make test # Run test suite
make build # Build distribution packages
make clean # Clean build artifacts
make upload-test # Upload to TestPyPI
make upload-prod # Upload to PyPI (production)
make check # Check package health
```
### Manual Development Setup
```bash
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
pip install -r requirements-dev.txt
# Install in development mode
pip install -e .
# Run the application
python -m horalog_cli.main
```
## License
MIT License
## Contributing
This is a simple, focused application. The goal is to keep it minimal and robust, especially for mobile use in Termux.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/horalog-cli",
"name": "horalog-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "journal, logging, terminal, cli, timestamp, yaml",
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/13/b7/74cb0e3b9c1ccf7f4649ec31e9f586b17078ccd2e6bd9ffc4c0366433882/horalog_cli-1.0.1.tar.gz",
"platform": null,
"description": "# HoraLog_CLI\r\n\r\nA simple, terminal-based journal application that logs sentences with timestamps into per-day YAML files.\r\n\r\n## Features\r\n\r\n- **Journal Mode**: Type entries with automatic timestamps\r\n- **Review Mode**: Browse and view past journal entries\r\n- **Minimal Dependencies**: Only requires `pyyaml`\r\n- **Termux Optimized**: Perfect for Android Termux\r\n- **Simple & Fast**: Does one thing well with minimal clutter\r\n\r\n## Installation\r\n\r\n### Standard Installation\r\n```bash\r\n# Install from PyPI (when published)\r\npip install horalog-cli\r\n\r\n# Or install from local directory\r\npip install -e .\r\n```\r\n\r\n### Android Termux Installation\r\n```bash\r\n# Install Python and pip if not already installed\r\npkg install python\r\n\r\n# Install pyyaml\r\npip install pyyaml\r\n\r\n# Clone or download the project\r\ngit clone <repository-url>\r\ncd HoraLog_CLI\r\n\r\n# Install in development mode\r\npip install -e .\r\n```\r\n\r\n## Usage\r\n\r\n### Journal Mode (Default)\r\nStart the application to begin journaling:\r\n```bash\r\nhoralog-cli\r\n```\r\n\r\nThis will:\r\n- Create a `journal/` folder if it doesn't exist\r\n- Load today's existing entries\r\n- Show a prompt like `[14:30:25] > `\r\n- Save each entry immediately when you press Enter\r\n- Keep previous entries visible while typing\r\n\r\n### Review Mode\r\nBrowse past journal entries:\r\n```bash\r\nhoralog-cli --review\r\n# or\r\nhoralog-cli -r\r\n```\r\n\r\nThis will show a numbered list of available dates and let you select one to view.\r\n\r\n### View Specific Date\r\nView entries for a specific date:\r\n```bash\r\nhoralog-cli --date 2025-01-15\r\n```\r\n\r\n## Example Output\r\n\r\n### Journal Mode\r\n```\r\nHoraLog_CLI - Journal Mode\r\nToday: 2025-01-17\r\n\r\nPrevious entries for today:\r\n[07:45:30] Early start to test the new features\r\n[09:30:15] Testing journal mode - everything looks good\r\n[10:15:45] Testing review mode - navigation works perfectly\r\n\r\nType your journal entries (Ctrl+C to exit):\r\n[12:00:00] > Working on documentation\r\n[12:00:00] Working on documentation\r\n[14:30:20] > Final testing and bug fixes\r\n[14:30:20] Final testing and bug fixes\r\n```\r\n\r\n### Review Mode\r\n```\r\nHoraLog_CLI - Review Mode\r\n\r\nAvailable journal files:\r\n1. 2025-01-17 (6 entries)\r\n2. 2025-01-16 (6 entries)\r\n3. 2025-01-15 (5 entries)\r\n\r\nEnter number (1-3) or date (YYYY-MM-DD): 2\r\n\r\nEntries for 2025-01-16:\r\n[08:30:15] Morning routine - coffee and planning\r\n[09:00:00] Started debugging the timestamp issue\r\n[11:20:45] Fixed the bug, now timestamps are working correctly\r\n[13:15:20] Team standup meeting\r\n[15:30:10] Working on the review mode functionality\r\n[17:00:00] Completed the review mode, ready for testing\r\n\r\nPress Enter to return to menu or Ctrl+C to exit\r\n```\r\n\r\n## File Structure\r\n\r\nJournal entries are stored in YAML files:\r\n```\r\njournal/\r\n\u251c\u2500\u2500 2025-01-15.yaml\r\n\u251c\u2500\u2500 2025-01-16.yaml\r\n\u2514\u2500\u2500 2025-01-17.yaml\r\n```\r\n\r\nEach YAML file contains:\r\n```yaml\r\nentries:\r\n - time: \"09:15:22\"\r\n text: \"Started working on the new project design\"\r\n - time: \"10:30:45\"\r\n text: \"Had a productive meeting with the team\"\r\n```\r\n\r\n## Commands\r\n\r\n- `horalog-cli` - Start journal mode (default)\r\n- `horalog-cli --review` or `horalog-cli -r` - Start review mode\r\n- `horalog-cli --date YYYY-MM-DD` - View specific date\r\n- `horalog-cli --help` - Show help\r\n- `horalog-cli --version` - Show version\r\n\r\n## Requirements\r\n\r\n- Python 3.8+\r\n- pyyaml>=6.0\r\n\r\n## Development\r\n\r\n### Quick Start\r\n```bash\r\n# Clone the repository\r\ngit clone <repository-url>\r\ncd HoraLog_CLI\r\n\r\n# Install development dependencies\r\nmake install-dev\r\n\r\n# Install package in development mode\r\nmake install\r\n\r\n# Run tests\r\nmake test\r\n\r\n# Build distribution\r\nmake build\r\n```\r\n\r\n### Available Commands\r\n```bash\r\nmake help # Show all available commands\r\nmake install # Install package in development mode\r\nmake install-dev # Install development dependencies\r\nmake test # Run test suite\r\nmake build # Build distribution packages\r\nmake clean # Clean build artifacts\r\nmake upload-test # Upload to TestPyPI\r\nmake upload-prod # Upload to PyPI (production)\r\nmake check # Check package health\r\n```\r\n\r\n### Manual Development Setup\r\n```bash\r\n# Create virtual environment\r\npython -m venv venv\r\nsource venv/bin/activate # On Windows: venv\\Scripts\\activate\r\n\r\n# Install dependencies\r\npip install -r requirements.txt\r\npip install -r requirements-dev.txt\r\n\r\n# Install in development mode\r\npip install -e .\r\n\r\n# Run the application\r\npython -m horalog_cli.main\r\n```\r\n\r\n## License\r\n\r\nMIT License\r\n\r\n## Contributing\r\n\r\nThis is a simple, focused application. The goal is to keep it minimal and robust, especially for mobile use in Termux.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Terminal-based journal with timestamp logging",
"version": "1.0.1",
"project_urls": {
"Bug Reports": "https://github.com/yourusername/horalog-cli/issues",
"Documentation": "https://github.com/yourusername/horalog-cli#readme",
"Homepage": "https://github.com/yourusername/horalog-cli",
"Source": "https://github.com/yourusername/horalog-cli"
},
"split_keywords": [
"journal",
" logging",
" terminal",
" cli",
" timestamp",
" yaml"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "918285c9e9f4f0acaf97cc9a90b491e25593c5ab88a14de3fb7e455e73fdbd63",
"md5": "d6d7b8f70a65ad62d684b88ad6276a57",
"sha256": "9a98af4733061e78f7f12a7b0234a585c54fad062a111bf8297cca08c2f91e91"
},
"downloads": -1,
"filename": "horalog_cli-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6d7b8f70a65ad62d684b88ad6276a57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13228,
"upload_time": "2025-08-15T12:26:43",
"upload_time_iso_8601": "2025-08-15T12:26:43.584075Z",
"url": "https://files.pythonhosted.org/packages/91/82/85c9e9f4f0acaf97cc9a90b491e25593c5ab88a14de3fb7e455e73fdbd63/horalog_cli-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "13b774cb0e3b9c1ccf7f4649ec31e9f586b17078ccd2e6bd9ffc4c0366433882",
"md5": "3f6e4c75d7b963828b38bbd9ef05978c",
"sha256": "09a183d7ab08726e8169c2b90b45952dbcf45403a777dff480864698ad1116ac"
},
"downloads": -1,
"filename": "horalog_cli-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3f6e4c75d7b963828b38bbd9ef05978c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11722,
"upload_time": "2025-08-15T12:26:44",
"upload_time_iso_8601": "2025-08-15T12:26:44.894916Z",
"url": "https://files.pythonhosted.org/packages/13/b7/74cb0e3b9c1ccf7f4649ec31e9f586b17078ccd2e6bd9ffc4c0366433882/horalog_cli-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-15 12:26:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "horalog-cli",
"github_not_found": true,
"lcname": "horalog-cli"
}
JSON
