Skip to main content

A command line tool for my image processing needs.

Project description

hyperdiary

https://img.shields.io/pypi/v/hyperdiary.svg https://github.com/luphord/hyperdiary/actions/workflows/lint-test.yml/badge.svg Documentation Status

A command line tool for writing diaries with hyperlinks. Free software, licensed under MIT license.

Installation

hyperdiary requires Python version 3.8 or later. Once you have Python and [pipx](https://pipx.pypa.io/stable/) installed on your machine (and available in your path), you can install hyperdiary by executing

pipx install hyperdiary

Setup

A project file hyperdiary.json is required to setup your diary. It should be of this form:

{
        "sources": [
                "2024/05.yaml",
                "2024/06.yaml"
        ],
        "expected": [
                {"start": "2024-05-01", "end": "2024-05-01"},
                {"start": "2024-06-09", "end": "2024-06-10"}
        ],
        "localization": {
                "months": ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
                           "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"],
                "date_fmt": "%-d.%-m.%Y"
        }
}

You diary content itself is entered in yaml files like this (2024/06.yaml):

2024-06-09:
  - Some entry goes here with a $special_identity|link
  - This entry is +surprise tagged +mytag +nexttag
  - This entry contains nothing new
2024-06-10:
  - Same $special_identity|link again and $New_Identity|NewIdentity
  - $test +mytag

Use $target|linktext to create a hyperlink to target showing text linktext. Use +mytag to add tag mytag.

Usage

usage: hyperdiary [-h]
          {check,stats,html,htmlfolder,hugo,tiddlers,tiddlywiki,view}
          ...

The hyperdiary main command line interface.

optional arguments:
        -h, --help            show this help message and exit

subcommands:
        {check,stats,html,htmlfolder,hugo,tiddlers,tiddlywiki,view}
                                Available subcommands
        check               Check entire diary for integrity up-to-dateness
        stats               Calculate impressive diary statistics
        html                Export diary to html
        htmlfolder          Export diary to html in folders
        hugo                Export diary to hugo static site format
        tiddlers            Export diary to tiddlywiki tiddlers format
        tiddlywiki          Export diary to tiddlywiki
        view                View entries on command line

History

0.7.0 (2024-05-02)

  • fix issue with tiddlywiki export (as the tiddlywiki file format has changed)

  • add support for Python 3.9 - 3.12

  • drop support for Python versions prior to 3.8

  • upgrade dependencies and dev dependencies

  • reformat code with black

  • migrate to github actions

0.6.1 (2020-10-21)

  • add support for Python 3.8

  • upgrade to flake8 3.8.4 and fix linter issues

  • replace deprecated test command

  • move to travis-ci.com

0.6.0 (2019-11-29)

  • promote status to alpha

  • introduced localization using hyperdiary.json; date format and month names so far

  • added tiddlers for month (calendar) and year overview with hyperlinks

  • Diary supports iteration by year/month

  • make docs work

0.5.0 (2019-11-06)

  • removed EntryType, refactored iteration, primarily passing Diary instances around

  • fix bug when an ID is followed by a bracket )

  • only line entries are allowed, no more dicts

0.4.0 (2019-10-30)

  • full type annotations added for package

  • linting and type checking in CI

  • EntryTypes Dict and DictLine are deprecated and will be removed in 0.5 (check issues a warning)

0.3.2 (2019-10-17)

  • fix linter configuration (and activate it)

  • make all hyperdiary source files PEP8 conform

  • set up bumpversion config

0.3.1 (2019-07-03)

  • open date ranges iterate until yesterday, not today

  • fix loading hyperdiary.json without expected field

0.3.0 (2019-06-19)

  • Expected date ranges for check subcommand can be specified

  • subcommand for export to tiddlywiki

  • Tests for various output formats

0.2.0 (2019-06-12)

  • stats subcommand can be invoked for all entries

  • Rename tiddlywiki subcommand to tiddlers for different future usage

  • Integrate Travis CI for automated testing

  • Add basic tests

  • Refactor diary/entry passing to subcommands

0.1.2 (2019-06-11)

  • Fix htmlfolder subcommand by packaging picnic.min.css

  • Fix view subcommand by using correct relative import

  • Avoid deprecation warning in stats subcommand by using yaml.SafeLoader

0.1.1 (2019-04-29)

  • Fix setup

0.1.0 (2019-04-28)

  • First release on PyPI

  • Import from fossil

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hyperdiary-0.7.0.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

hyperdiary-0.7.0-py2.py3-none-any.whl (37.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file hyperdiary-0.7.0.tar.gz.

File metadata

  • Download URL: hyperdiary-0.7.0.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for hyperdiary-0.7.0.tar.gz
Algorithm Hash digest
SHA256 6c907c9aae29220d255589c0e31c321921355da7ebabf7f4d5f85776d8875b43
MD5 98b8662bb53ea7f6bf1dbefa2cc59b0d
BLAKE2b-256 28430130a7125c524e228e8835e77597e3f19cdc4b8888b4c5cac2e66e061e8f

See more details on using hashes here.

File details

Details for the file hyperdiary-0.7.0-py2.py3-none-any.whl.

File metadata

  • Download URL: hyperdiary-0.7.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 37.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for hyperdiary-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e93bb11c32eb5b684ef92ecc019f97d10a75cfdb035ac8516b59c0996dc89736
MD5 47c1b33690fb297e6fdabb1eff30ffb8
BLAKE2b-256 fab20a977ff4107658ef7a529b710710246aac3deb987c1c43c72e634543c5f9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page