Skip to content

Commit a4201cd

Browse files
Create README.md
1 parent 4e668cf commit a4201cd

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Personal Journal Entry Generator
2+
3+
A simple Python script that generates thoughtful daily journal prompts to help users reflect on their day and maintain a consistent journaling practice.
4+
5+
## Overview
6+
7+
This tool provides randomized writing prompts across five different categories:
8+
- **Gratitude**: Prompts focused on appreciation and positive experiences
9+
- **Reflection**: Questions that encourage self-awareness and growth
10+
- **Goals**: Prompts related to personal objectives and progress
11+
- **Creativity**: Fun and imaginative questions to spark creative thinking
12+
- **Mindfulness**: Prompts centered on emotional awareness and self-care
13+
14+
## Features
15+
16+
- 📝 Generates random daily journal prompts
17+
- 🎯 Organizes prompts by category for focused reflection
18+
- 📅 Displays current date and time with each prompt
19+
- 💾 Includes functionality to save journal entries to JSON format
20+
- 🔄 Simple command-line interface
21+
- ✨ Under 100 lines of Python code
22+
23+
## Requirements
24+
25+
- Python 3.6 or higher
26+
- No external dependencies (uses only standard library)
27+
28+
## Installation
29+
30+
1. Clone this repository or download the `journal_entry_generator.py` file
31+
2. Navigate to the directory containing the script
32+
33+
## Usage
34+
35+
### Basic Usage
36+
37+
Run the script to get a random daily prompt:
38+
39+
```bash
40+
python journal_entry_generator.py
41+
```
42+
43+
This will display:
44+
- Current date and time
45+
- A randomly selected category
46+
- A thoughtful writing prompt
47+
48+
### Example Output
49+
50+
```
51+
============================================================
52+
Journal Entry - 2025-10-12 at 08:30 PM
53+
============================================================
54+
55+
Category: Gratitude
56+
57+
Today's Prompt:
58+
What are three things you're grateful for today?
59+
60+
============================================================
61+
```
62+
63+
## Code Structure
64+
65+
- `PROMPTS`: Dictionary containing categorized journal prompts
66+
- `get_daily_prompt()`: Returns a random prompt (optionally from a specific category)
67+
- `display_prompt_with_timestamp()`: Shows prompt with formatted date/time
68+
- `save_entry()`: Saves journal entries to a JSON file (for future enhancement)
69+
70+
## Contributing
71+
72+
This project is part of the [100 Lines of Python Code](https://github.com/sumanth-0/100LinesOfPythonCode) repository. Contributions and improvements are welcome!
73+
74+
## Related Issue
75+
76+
Created for issue #768: Personal Journal Entry Generator
77+
78+
## License
79+
80+
This code is part of the 100LinesOfPythonCode project. Please refer to the main repository for licensing information.
81+
82+
## Future Enhancements
83+
84+
- Add command-line arguments to select specific categories
85+
- Implement interactive mode for writing and saving entries
86+
- Add export options (Markdown, plain text)
87+
- Include prompt history tracking to avoid repetition
88+
- Add custom prompt management
89+
90+
---
91+
92+
*Happy journaling! 📓✨*

0 commit comments

Comments
 (0)