diarydek 0.0.25

A diary tool.

diarydek

'diarydek' is a python script to handle diary entries. It is still in an Alpha stage of development, meaning that anything you see here might change in the future. Heck, some of it may be wrong even as you read this!

Sample Usage

Get help.

diarydek --help
diarydek -h

Add an entry that has no categories.

diarydek I ate breakfast.

Add an entry that has a single category.

diarydek I ate a salad for lunch. : food

Add an entry that has a two categories.

diarydek I ate a salad for lunch. : food healthy

See all entries

diarydek --list

See entries with caw in the entry.

diarydek --list caw

See entries with tag sound.

diarydek --list : sound

Rename a tag.

diarydek --renameTag oldName newName

Find tag usage

diarydek --showTags

Combining databases.

The following appends the contents of the database B to database A.

diarydek --database ~/B.db --writeCSV > B.csv
diarydek --database ~/A.db --readCSV B.csv

Developer's Notes

The following builds locally, when run from the source directory.

python3 -m pip install . --break-system-packages

If this works in testing, consider uploading to pypi. Be sure to bump the version number first to avoid conflict with a version on pypi. Do this in two steps:

1. Edit the pyproject.toml file, altering the line defining version.

2. Edit the src/diarydek/diarydek.py file, altering the definition of self.appversion.

With this done, it is possible to upload to pypi, which is done with the following. (The first step just ensures that you don't try to upload any old sources that you might have built up previously with twine.)

rm dist/*                      # remove any existing files
python3 -m build               # build, installing 2 files in dist
python3 -m twine upload dist/* # upload to pypi

Once this is done, you can install the pypi version using the following. If it works, then you can have some assurance that users can install it (using the second step).

pip uninstall diarydek --break-system-packages # remove any existing version
pip install diarydek --break-system-packages   # install new, from pypi

Suggested aliases

Although you can use a single diary for all your work, it can sometimes help to have multiple databases, e.g. for privacy. I do things like the following.

alias ',dp'='diarydek --database=~/Documents/diary/personal.db'
alias ',dw'='diarydek --database=~/Documents/diary/work.db'

References

1. https://packaging.python.org/tutorials/packaging-projects/ provides information on packaging.