# ENOUGH- The CLI Journal
A flexible journaling system for personal growth and self-reflection, supporting customizable prompts, scheduled exercises, and structured reviews.
## TODO: Installation Setup
- [ ] Set up PyPI account and configure credentials
- [ ] Create and test PyPI package upload workflow
- [ ] Generate and verify package hash for AUR package
- [ ] Test installation scripts on different platforms
- [ ] Add version badges and PyPI status to README
- [ ] Create detailed installation troubleshooting guide
**Note:** Currently in development. Installation methods will be fully implemented in upcoming updates. For now, use the manual installation method:
```bash
git clone https://github.com/yourusername/personal-growth-journal.git
cd personal-growth-journal
pip install -e .
```
## Features
- Custom prompt scheduling (daily, weekly, monthly)
- Follow-up questions and response tracking
- Weekly review system
- Progress tracking and statistics
- Tag-based organization
- Flexible response formats
## Installation
### Option 1: PyPI (All Platforms)
Install directly from PyPI:
```bash
pip install sentence-completion
```
### Option 2: Arch Linux (AUR)
Install using your preferred AUR helper:
```bash
yay -S python-sentence-completion
```
Or manually:
```bash
git clone https://aur.archlinux.org/python-sentence-completion.git
cd python-sentence-completion
makepkg -si
```
### Option 3: Automatic Installation Scripts
#### Linux/macOS:
```bash
git clone https://github.com/yourusername/personal-growth-journal.git
cd personal-growth-journal
chmod +x install.sh
./install.sh
```
#### Windows:
```bash
git clone https://github.com/yourusername/personal-growth-journal.git
cd personal-growth-journal
install.bat
```
### Option 4: Manual Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/personal-growth-journal.git
cd personal-growth-journal
```
2. Create and activate a virtual environment (optional but recommended):
```bash
python -m venv venv
source venv/bin/activate # Linux/macOS
venv\Scripts\activate.bat # Windows
```
3. Install the package:
```bash
pip install -e .
```
## Usage
### Starting an Exercise
```bash
sentence-completion start exercises/daily.yaml
```
### Running Weekly Review
```bash
sentence-completion review exercises/daily.yaml
```
### Adding Custom Entries
```bash
sentence-completion add "What did I learn today?" --tags learning,reflection --answers 3
```
## Exercise File Format
Exercise files use YAML format with the following structure:
```yaml
name: "Daily Reflection"
frequency: "daily" # or "weekly", "monthly", or custom settings
# For custom frequency, specify days, weeks and months
frequency:
days: [1, 3, 5] # 1=Monday, 7=Sunday
weekly: [1, 3, 5] # 1=Every week, 3=Every 3 weeks
monthly: [1, 3, 5] # 1=Every month, 3=Every 3 months
months: [1, 3, 5] # 1=January, 12=December
# Default settings
answers_required: 1 # Number of responses required
min_words: 0 # Minimum words per response
max_time: 300 # Maximum time in seconds
# The actual prompts
prompts:
p_000: # You have to assign every question an ID like so
prompt: "What's on my mind right now..."
tags: ["reflection"]
answers_required: 3 # Override default
p_001: # Sequential IDs required
prompt: "What am I grateful for today?"
tags: ["gratitude"]
follow_up: "p_002" # Reference to follow-up question
p_002:
prompt: "How can I express this gratitude?"
tags: ["action", "gratitude"]
```
## Directory Structure
```
Core/
├── sentence_completion/ # Main package
│ ├── cli/ # Command line interface
│ ├── core/ # Core functionality
│ └── utils/ # Utility functions
│
├── Submissions/ # Journal entries
│ ├── Daily_Reflection/ # Organized by exercise
│ │ ├── YYYY_MM_DD_1.yaml
│ │ └── YYYY_MM_DD_review.yaml
│ └── Custom_Entries/ # Custom journal entries
│
└── Exercises/ # Exercise templates
├── daily.yaml
└── weekly.yaml
```
## Contributing
1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request
## License
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "enough-journal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, journal, mindfulness, personal-growth, self-reflection",
"author": null,
"author_email": "Stephen Piper <sipos.istvan.a@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d4/7d/e217d587c2eaa13b30658819689610c500ffebae701d68938f44e8c5406c/enough_journal-0.1.0.tar.gz",
"platform": null,
"description": "# ENOUGH- The CLI Journal\n\nA flexible journaling system for personal growth and self-reflection, supporting customizable prompts, scheduled exercises, and structured reviews.\n\n## TODO: Installation Setup\n- [ ] Set up PyPI account and configure credentials\n- [ ] Create and test PyPI package upload workflow\n- [ ] Generate and verify package hash for AUR package\n- [ ] Test installation scripts on different platforms\n- [ ] Add version badges and PyPI status to README\n- [ ] Create detailed installation troubleshooting guide\n\n**Note:** Currently in development. Installation methods will be fully implemented in upcoming updates. For now, use the manual installation method:\n\n```bash\ngit clone https://github.com/yourusername/personal-growth-journal.git\ncd personal-growth-journal\npip install -e .\n```\n\n## Features\n\n- Custom prompt scheduling (daily, weekly, monthly)\n- Follow-up questions and response tracking\n- Weekly review system\n- Progress tracking and statistics\n- Tag-based organization\n- Flexible response formats\n\n## Installation\n\n### Option 1: PyPI (All Platforms)\n\nInstall directly from PyPI:\n```bash\npip install sentence-completion\n```\n\n### Option 2: Arch Linux (AUR)\n\nInstall using your preferred AUR helper:\n```bash\nyay -S python-sentence-completion\n```\n\nOr manually:\n```bash\ngit clone https://aur.archlinux.org/python-sentence-completion.git\ncd python-sentence-completion\nmakepkg -si\n```\n\n### Option 3: Automatic Installation Scripts\n\n#### Linux/macOS:\n```bash\ngit clone https://github.com/yourusername/personal-growth-journal.git\ncd personal-growth-journal\nchmod +x install.sh\n./install.sh\n```\n\n#### Windows:\n```bash\ngit clone https://github.com/yourusername/personal-growth-journal.git\ncd personal-growth-journal\ninstall.bat\n```\n\n### Option 4: Manual Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/yourusername/personal-growth-journal.git\ncd personal-growth-journal\n```\n\n2. Create and activate a virtual environment (optional but recommended):\n```bash\npython -m venv venv\nsource venv/bin/activate # Linux/macOS\nvenv\\Scripts\\activate.bat # Windows\n```\n\n3. Install the package:\n```bash\npip install -e .\n```\n\n## Usage\n\n### Starting an Exercise\n\n```bash\nsentence-completion start exercises/daily.yaml\n```\n\n### Running Weekly Review\n\n```bash\nsentence-completion review exercises/daily.yaml\n```\n\n### Adding Custom Entries\n\n```bash\nsentence-completion add \"What did I learn today?\" --tags learning,reflection --answers 3\n```\n\n## Exercise File Format\n\nExercise files use YAML format with the following structure:\n\n```yaml\nname: \"Daily Reflection\"\nfrequency: \"daily\" # or \"weekly\", \"monthly\", or custom settings\n\n# For custom frequency, specify days, weeks and months\nfrequency:\n days: [1, 3, 5] # 1=Monday, 7=Sunday\n weekly: [1, 3, 5] # 1=Every week, 3=Every 3 weeks\n monthly: [1, 3, 5] # 1=Every month, 3=Every 3 months\n months: [1, 3, 5] # 1=January, 12=December\n\n# Default settings\nanswers_required: 1 # Number of responses required\nmin_words: 0 # Minimum words per response\nmax_time: 300 # Maximum time in seconds\n\n# The actual prompts\nprompts:\n p_000: # You have to assign every question an ID like so\n prompt: \"What's on my mind right now...\"\n tags: [\"reflection\"]\n answers_required: 3 # Override default\n \n p_001: # Sequential IDs required\n prompt: \"What am I grateful for today?\"\n tags: [\"gratitude\"]\n follow_up: \"p_002\" # Reference to follow-up question\n \n p_002:\n prompt: \"How can I express this gratitude?\"\n tags: [\"action\", \"gratitude\"]\n```\n\n## Directory Structure\n\n```\nCore/\n\u251c\u2500\u2500 sentence_completion/ # Main package\n\u2502 \u251c\u2500\u2500 cli/ # Command line interface\n\u2502 \u251c\u2500\u2500 core/ # Core functionality\n\u2502 \u2514\u2500\u2500 utils/ # Utility functions\n\u2502\n\u251c\u2500\u2500 Submissions/ # Journal entries\n\u2502 \u251c\u2500\u2500 Daily_Reflection/ # Organized by exercise\n\u2502 \u2502 \u251c\u2500\u2500 YYYY_MM_DD_1.yaml\n\u2502 \u2502 \u2514\u2500\u2500 YYYY_MM_DD_review.yaml\n\u2502 \u2514\u2500\u2500 Custom_Entries/ # Custom journal entries\n\u2502\n\u2514\u2500\u2500 Exercises/ # Exercise templates\n \u251c\u2500\u2500 daily.yaml\n \u2514\u2500\u2500 weekly.yaml\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A mindful journaling tool for self-reflection and personal growth",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/enough",
"Issues": "https://github.com/yourusername/enough/issues"
},
"split_keywords": [
"cli",
" journal",
" mindfulness",
" personal-growth",
" self-reflection"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bfede6b287ae5c9c27776865ad49a6dc5907d1e24bf091a97cb5017f310d9752",
"md5": "45749e3d1ce0c4e43a1000da53387309",
"sha256": "4868a99ecd69cdcef1a71248e3f7abcd5fe40ebbedaae545a41109c6bce76eed"
},
"downloads": -1,
"filename": "enough_journal-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45749e3d1ce0c4e43a1000da53387309",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 28349,
"upload_time": "2025-07-08T13:51:42",
"upload_time_iso_8601": "2025-07-08T13:51:42.961095Z",
"url": "https://files.pythonhosted.org/packages/bf/ed/e6b287ae5c9c27776865ad49a6dc5907d1e24bf091a97cb5017f310d9752/enough_journal-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d47de217d587c2eaa13b30658819689610c500ffebae701d68938f44e8c5406c",
"md5": "5170f264609c4b4f9a91e2e3de795d6f",
"sha256": "3bf753e52ede23df5347786cb615b7b16a2a8f95fcb305754fc4ce7ba79a5925"
},
"downloads": -1,
"filename": "enough_journal-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5170f264609c4b4f9a91e2e3de795d6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19972,
"upload_time": "2025-07-08T13:51:44",
"upload_time_iso_8601": "2025-07-08T13:51:44.410069Z",
"url": "https://files.pythonhosted.org/packages/d4/7d/e217d587c2eaa13b30658819689610c500ffebae701d68938f44e8c5406c/enough_journal-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 13:51:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "enough",
"github_not_found": true,
"lcname": "enough-journal"
}
JSON
