Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/askedrelic/journal
Python CLI tool to help with keeping a work/personal journal
https://github.com/askedrelic/journal
Last synced: about 2 months ago
JSON representation
Python CLI tool to help with keeping a work/personal journal
- Host: GitHub
- URL: https://github.com/askedrelic/journal
- Owner: askedrelic
- License: mit
- Created: 2011-08-15T00:34:19.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2021-09-29T00:15:42.000Z (over 3 years ago)
- Last Synced: 2024-08-09T13:40:27.027Z (5 months ago)
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 28
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
- Changelog: HISTORY.markdown
- License: LICENSE.txt
Awesome Lists containing this project
- project-awesome - askedrelic/journal - Python CLI tool to help with keeping a work/personal journal (Python)
README
#Journal
Journal is a Python command line tool to help with keeping a date and time
organized journal for work, personal, or any reason really!Inspired by Peter Lyons' [article][1] on career development, my own experiences,
and too much free time.Related:
* [My blog post explaining Journal][2]
##Installation
Journal is on pypi at [http://pypi.python.org/pypi/journal/][3]
To install, from a command line:
$ pip install journal
Journal only requires Python, (tested on Python 2.5, 2.6, 2.7).
The `journal` command should now be available on your command line.
##Usage
It's as simple as:
$ journal "Task foo completed"
and a `~/.journal/[DATE].txt` file will be created using the current date with
a timestamp and your entry appended to that file. Keep entering your tasks you
complete during the day and then you can quickly view your work at the end of
the day. Or review what you did yesterday, just before your morning scrum
meeting! Or review what you did last week, when you come back on Monday! Build
a simple record of your work and gain better understanding of your work.The API for viewing and listing previous entries is currently a WIP, but you
should be able to view specific entries for a day by using the flag `--view|-v`.Short tags work with these dates.
$ journal --view "yesterday"
$ journal --view "12 days ago"
$ journal --view "8/14"# Easiest way to view today (t)
$ journal -vt# Easiest way to view yesterday (y)
$ journal -vyYou can view all entries since a specific previous date, using the flag
`--since`. This is sparse output, dates without entries will be skipped quietly.$ journal --since "yesterday"
$ journal --since "7 days ago"##Advanced usage
By default, journal entries are stored in `~/.journal`. By providing the
`--location|-l path` command line switch entries will be read from & written to
the provided directory. This functionality is useful for having journals dealing
with separate domains:$ journal -l ~/.work "Got all of the monies"
$ journal -l ~/.home "Spent all the monies"See below for using a `.journalrc` to define these journals & storage locations.
###Configuration
You can create a `.journalrc` file (or one specified with the `-c` switch) to
define default journal directories:[journal]
default: work[home]
location: ~/Dropbox/journals/home[work]
location: ~/Dropbox/journals/workWith multiple journals defined, you can use the `--journal|-j name` switch to
choose which journal to write to.[1]: http://peterlyons.com/leveling-up
[2]: http://asktherelic.com/2011/08/16/journaling/
[3]: http://pypi.python.org/pypi/journal/