daily-cli


Namedaily-cli JSON
Version 2.1.2 PyPI version JSON
download
home_pagehttps://github.com/OneRedDime/daily
SummaryCommand-line notebook for daily entries.
upload_time2024-01-23 21:55:04
maintainer
docs_urlNone
authorOneRedDime
requires_python>=3, <4
licenseGPLv2
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =======
 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/50/08/606066bfc18a50deb1b391ee69d66d052662da5e955f63ce93fb057afe9c/daily-cli-2.1.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.1.2",
    "project_urls": {
        "Homepage": "https://github.com/OneRedDime/daily"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c28668eb806b27d3467498965547a07e2d123212a6b83123de98fc3f219afebf",
                "md5": "783035c0962ff6bd346e11ed498ec600",
                "sha256": "e38b54ab98acdd2f81a0285b1dc6946a7d7f38566b3c4039bba8488ee94ba95c"
            },
            "downloads": -1,
            "filename": "daily_cli-2.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "783035c0962ff6bd346e11ed498ec600",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3, <4",
            "size": 27085,
            "upload_time": "2024-01-23T21:55:02",
            "upload_time_iso_8601": "2024-01-23T21:55:02.114290Z",
            "url": "https://files.pythonhosted.org/packages/c2/86/68eb806b27d3467498965547a07e2d123212a6b83123de98fc3f219afebf/daily_cli-2.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5008606066bfc18a50deb1b391ee69d66d052662da5e955f63ce93fb057afe9c",
                "md5": "3a672becbb58e9f74d0f35c296fab445",
                "sha256": "111162ec60b469911cbdb62407c97eb2f883c3f0a07b81e5c98f398ea239292d"
            },
            "downloads": -1,
            "filename": "daily-cli-2.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3a672becbb58e9f74d0f35c296fab445",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3, <4",
            "size": 25376,
            "upload_time": "2024-01-23T21:55:04",
            "upload_time_iso_8601": "2024-01-23T21:55:04.393711Z",
            "url": "https://files.pythonhosted.org/packages/50/08/606066bfc18a50deb1b391ee69d66d052662da5e955f63ce93fb057afe9c/daily-cli-2.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-23 21:55:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OneRedDime",
    "github_project": "daily",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "daily-cli"
}
        
Elapsed time: 0.16005s