=======
daily
=======
Hello and welcome to daily, a program for command-line journaling. Each
journal entry is stored in a file named after the date in YYYY-mm-dd format
in either MD or RST format.
Building and installation
=========================
Available via PyPi. ``pip3 install daily-cli --user``
Alternatively, clone this repo and run these commands.
::
make
pip3 install --user .
The man pages will be installed at ``$HOME/.local/usr/share/man``
and the bash completion script will be installed at
``$HOME/.local/etc/bash_completion.d/daily_completion.sh``. Update your bashrc.
Usage
=====
Usage is detailed in the man pages under ``./doc/man``. Start with ``daily.1``,
but a general quick start cookbook...
::
daily # Perform first-time setup
daily add # Edit today's entry.
daily show # Show previous 2 weeks of entries
daily add -d yesterday # Add or edit an entry on a specific date.
daily add --before today # Batch edit any entries before today
daily show workout todo # Show only specific headings for entries
daily add workout # Edit specific headings for an entry.
daily todo # Print next 2 weeks of todos
Entries have a title named after the date, a desription, headings, and
metadata all built in to the text. Here is a simple example in markdown.
::
# 2022-10-10, Mon
I went to my daughter's play.
## Workout
And did like a gazillion pushups.
<!--- attributes --->
---
id: some-internal-id
tags: []
And an example in RST.
::
=================
2022-10-10, Mon
=================
This semester in college is really starting to grind.
Todo
====
- 8am Calculus class.
- 9am Workout
.. code-block:: yaml
---
id: some-internal-id
tags: []
Usage with Vimwiki
-------------------
Modify daily.ini (installed in ``~/.config/daily`` after a first run) to change
the journal's directory to your vimwiki diary, and be sure the format is "md".
Also install the ``generate-vimwiki-diary-template`` file to your ~/.vim/bin
directory. This will make it so vim auto-generates daily's entry text for new
markdown files in the vimwiki diary directory. This must be done manually.
Maintenance and versioning
==========================
Update the CHANGELOG when cutting a new release, then update the version
in setup.py. Then commit and tag it named after the release. Then...
- Run ``make`` to build the package.
- ``make release`` to upload to PyPi.
Raw data
{
"_id": null,
"home_page": "https://github.com/OneRedDime/daily",
"name": "daily-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3, <4",
"maintainer_email": "",
"keywords": "",
"author": "OneRedDime",
"author_email": "onereddime@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/cd/4c/6767261a019403833082babbcd6feab712d52d4285b9f2aa7b4d278f054f/daily-cli-2.0.2.tar.gz",
"platform": null,
"description": "=======\n daily\n=======\nHello and welcome to daily, a program for command-line journaling. Each\njournal entry is stored in a file named after the date in YYYY-mm-dd format\nin either MD or RST format.\n\nBuilding and installation\n=========================\nAvailable via PyPi. ``pip3 install daily-cli --user``\n\nAlternatively, clone this repo and run these commands.\n\n::\n\n make\n pip3 install --user .\n\nThe man pages will be installed at ``$HOME/.local/usr/share/man``\nand the bash completion script will be installed at\n``$HOME/.local/etc/bash_completion.d/daily_completion.sh``. Update your bashrc.\n\nUsage\n=====\nUsage is detailed in the man pages under ``./doc/man``. Start with ``daily.1``,\nbut a general quick start cookbook...\n\n::\n\n daily # Perform first-time setup\n daily add # Edit today's entry.\n daily show # Show previous 2 weeks of entries\n daily add -d yesterday # Add or edit an entry on a specific date.\n daily add --before today # Batch edit any entries before today\n daily show workout todo # Show only specific headings for entries\n daily add workout # Edit specific headings for an entry.\n\n daily todo # Print next 2 weeks of todos\n\nEntries have a title named after the date, a desription, headings, and\nmetadata all built in to the text. Here is a simple example in markdown.\n\n::\n\n # 2022-10-10, Mon\n I went to my daughter's play.\n\n ## Workout\n And did like a gazillion pushups.\n\n\n <!--- attributes --->\n ---\n id: some-internal-id\n tags: []\n\nAnd an example in RST.\n\n::\n\n =================\n 2022-10-10, Mon\n =================\n This semester in college is really starting to grind.\n\n Todo\n ====\n - 8am Calculus class.\n - 9am Workout\n\n \n .. code-block:: yaml\n \n ---\n id: some-internal-id\n tags: []\n\nUsage with Vimwiki \n-------------------\nModify daily.ini (installed in ``~/.config/daily`` after a first run) to change\nthe journal's directory to your vimwiki diary, and be sure the format is \"md\".\n\nAlso install the ``generate-vimwiki-diary-template`` file to your ~/.vim/bin\ndirectory. This will make it so vim auto-generates daily's entry text for new\nmarkdown files in the vimwiki diary directory. This must be done manually.\n\nMaintenance and versioning\n==========================\nUpdate the CHANGELOG when cutting a new release, then update the version\nin setup.py. Then commit and tag it named after the release. Then...\n\n- Run ``make`` to build the package.\n- ``make release`` to upload to PyPi.\n",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "Command-line notebook for daily entries.",
"version": "2.0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "365b3e2b39bc5aaff0bbc1083917bac04b04e2b2d35d90ae0b9a6afc437b0f83",
"md5": "e62b544151d6e1994f7dfe0b0a542548",
"sha256": "2eafea66846ad36dd9c1ab4090fe07026d9cc28d7b54dd343a080fd1863bd39f"
},
"downloads": -1,
"filename": "daily_cli-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e62b544151d6e1994f7dfe0b0a542548",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3, <4",
"size": 19170,
"upload_time": "2023-03-15T17:51:41",
"upload_time_iso_8601": "2023-03-15T17:51:41.470382Z",
"url": "https://files.pythonhosted.org/packages/36/5b/3e2b39bc5aaff0bbc1083917bac04b04e2b2d35d90ae0b9a6afc437b0f83/daily_cli-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd4c6767261a019403833082babbcd6feab712d52d4285b9f2aa7b4d278f054f",
"md5": "e6d6e60f742c3a1bfa161b71e259486c",
"sha256": "04c2f0efb90c66cce596142b31b44ce2a3c3eeffc91df94872a4f41be5f6575a"
},
"downloads": -1,
"filename": "daily-cli-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "e6d6e60f742c3a1bfa161b71e259486c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3, <4",
"size": 16650,
"upload_time": "2023-03-15T17:51:43",
"upload_time_iso_8601": "2023-03-15T17:51:43.668651Z",
"url": "https://files.pythonhosted.org/packages/cd/4c/6767261a019403833082babbcd6feab712d52d4285b9f2aa7b4d278f054f/daily-cli-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-15 17:51:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "OneRedDime",
"github_project": "daily",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "daily-cli"
}
JSON
