Showing preview only (737K chars total). Download the full file or copy to clipboard to get everything.
Repository: jrnl-org/jrnl
Branch: develop
Commit: 93e19d954114
Files: 233
Total size: 680.1 KB
Directory structure:
gitextract_j41touky/
├── .build/
│ └── allow_all_python_version.py
├── .gitattributes
├── .github/
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.yaml
│ │ ├── config.yml
│ │ ├── documentation.yaml
│ │ ├── feature_request.yaml
│ │ └── support_request.yaml
│ ├── PULL_REQUEST_TEMPLATE.md
│ ├── actionlint-matcher.json
│ ├── actions/
│ │ └── run_tests/
│ │ └── action.yaml
│ ├── lock.yml
│ ├── renovate.json
│ ├── stale.yml
│ └── workflows/
│ ├── changelog.yaml
│ ├── docs.yaml
│ ├── release.yaml
│ ├── testing_pipelines.yaml
│ ├── testing_prs.yaml
│ └── testing_schedule.yaml
├── .gitignore
├── .readthedocs.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── SECURITY.md
├── docs/
│ ├── advanced.md
│ ├── contributing.md
│ ├── encryption.md
│ ├── external-editors.md
│ ├── formats.md
│ ├── installation.md
│ ├── journal-types.md
│ ├── overview.md
│ ├── privacy-and-security.md
│ ├── reference-command-line.md
│ ├── reference-config-file.md
│ ├── tips-and-tricks.md
│ └── usage.md
├── docs_theme/
│ ├── assets/
│ │ ├── colors.css
│ │ ├── highlight.css
│ │ ├── index.css
│ │ └── theme.css
│ ├── breadcrumbs.html
│ ├── index.html
│ ├── index.js
│ ├── main.html
│ ├── requirements.txt
│ └── search.html
├── issue_template.md
├── jrnl/
│ ├── __init__.py
│ ├── __main__.py
│ ├── __version__.py
│ ├── args.py
│ ├── color.py
│ ├── commands.py
│ ├── config.py
│ ├── controller.py
│ ├── editor.py
│ ├── encryption/
│ │ ├── BaseEncryption.py
│ │ ├── BaseKeyEncryption.py
│ │ ├── BasePasswordEncryption.py
│ │ ├── Jrnlv1Encryption.py
│ │ ├── Jrnlv2Encryption.py
│ │ ├── NoEncryption.py
│ │ └── __init__.py
│ ├── exception.py
│ ├── install.py
│ ├── journals/
│ │ ├── DayOneJournal.py
│ │ ├── Entry.py
│ │ ├── FolderJournal.py
│ │ ├── Journal.py
│ │ └── __init__.py
│ ├── keyring.py
│ ├── main.py
│ ├── messages/
│ │ ├── Message.py
│ │ ├── MsgStyle.py
│ │ ├── MsgText.py
│ │ └── __init__.py
│ ├── os_compat.py
│ ├── output.py
│ ├── override.py
│ ├── path.py
│ ├── plugins/
│ │ ├── __init__.py
│ │ ├── calendar_heatmap_exporter.py
│ │ ├── dates_exporter.py
│ │ ├── fancy_exporter.py
│ │ ├── jrnl_importer.py
│ │ ├── json_exporter.py
│ │ ├── markdown_exporter.py
│ │ ├── tag_exporter.py
│ │ ├── text_exporter.py
│ │ ├── util.py
│ │ ├── xml_exporter.py
│ │ └── yaml_exporter.py
│ ├── prompt.py
│ ├── templates/
│ │ └── sample.template
│ ├── time.py
│ └── upgrade.py
├── mkdocs.yml
├── package.json
├── pyproject.toml
├── tasks.py
└── tests/
├── __init__.py
├── bdd/
│ ├── features/
│ │ ├── actions.feature
│ │ ├── build.feature
│ │ ├── change_time.feature
│ │ ├── config_file.feature
│ │ ├── core.feature
│ │ ├── datetime.feature
│ │ ├── delete.feature
│ │ ├── encrypt.feature
│ │ ├── file_storage.feature
│ │ ├── format.feature
│ │ ├── import.feature
│ │ ├── install.feature
│ │ ├── multiple_journals.feature
│ │ ├── override.feature
│ │ ├── password.feature
│ │ ├── search.feature
│ │ ├── star.feature
│ │ ├── tag.feature
│ │ ├── template.feature
│ │ ├── upgrade.feature
│ │ └── write.feature
│ └── test_features.py
├── conftest.py
├── data/
│ ├── configs/
│ │ ├── basic_dayone.yaml
│ │ ├── basic_encrypted.yaml
│ │ ├── basic_folder.yaml
│ │ ├── basic_onefile.yaml
│ │ ├── brackets.yaml
│ │ ├── bug153.yaml
│ │ ├── bug780.yaml
│ │ ├── dayone.yaml
│ │ ├── dayone_empty.yaml
│ │ ├── deletion.yaml
│ │ ├── deletion_filters.yaml
│ │ ├── duplicate_keys.yaml
│ │ ├── editor-args.yaml
│ │ ├── editor.yaml
│ │ ├── editor_empty_folder.yaml
│ │ ├── editor_encrypted.yaml
│ │ ├── editor_markdown_extension.yaml
│ │ ├── empty_file.yaml
│ │ ├── empty_folder.yaml
│ │ ├── encrypted.yaml
│ │ ├── encrypted_old.json
│ │ ├── encrypted_old.yaml
│ │ ├── format_md.yaml
│ │ ├── format_text.yaml
│ │ ├── invalid_color.yaml
│ │ ├── linewrap_auto.yaml
│ │ ├── little_endian_dates.yaml
│ │ ├── markdown-headings-335.yaml
│ │ ├── missing_directory.yaml
│ │ ├── missing_journal.yaml
│ │ ├── mostlyreadabledates.yaml
│ │ ├── multiline-tags.yaml
│ │ ├── multiline.yaml
│ │ ├── multiple.yaml
│ │ ├── no_colors.yaml
│ │ ├── no_default_journal.yaml
│ │ ├── simple.yaml
│ │ ├── tags-216.yaml
│ │ ├── tags-237.yaml
│ │ ├── tags.yaml
│ │ ├── unreadabledates.yaml
│ │ ├── upgrade_from_195.json
│ │ ├── upgrade_from_195_little_endian_dates.json
│ │ ├── upgrade_from_195_with_missing_encrypted_journal.json
│ │ └── upgrade_from_195_with_missing_journal.json
│ ├── journals/
│ │ ├── basic_dayone.dayone/
│ │ │ └── entries/
│ │ │ ├── D04D335AFED711EABA18FAFFC2100C3D.doentry
│ │ │ ├── FC8A86CAFED711EA8892FAFFC2100C3D.doentry
│ │ │ └── FD8ABC8EFED711EABC35FAFFC2100C3D.doentry
│ │ ├── basic_encrypted.journal
│ │ ├── basic_folder/
│ │ │ ├── 2020/
│ │ │ │ ├── 08/
│ │ │ │ │ ├── 29.txt
│ │ │ │ │ └── 31.txt
│ │ │ │ ├── 09/
│ │ │ │ │ ├── 24.txt
│ │ │ │ │ └── should-be-ignored.txt
│ │ │ │ └── should-be-ignored.txt
│ │ │ └── should-be-ignored.txt
│ │ ├── basic_onefile.journal
│ │ ├── brackets.journal
│ │ ├── bug153.dayone/
│ │ │ └── entries/
│ │ │ ├── B40EE704E15846DE8D45C44118A4D511.doentry
│ │ │ └── B40EE704E15846DE8D45C44118A4D512.doentry
│ │ ├── bug780.dayone/
│ │ │ └── entries/
│ │ │ └── 48A25033B34047C591160A4480197D8B.doentry
│ │ ├── dayone.dayone/
│ │ │ └── entries/
│ │ │ ├── 044F3747A38546168B572C2E3F217FA2.doentry
│ │ │ ├── 0BDDD6CDA43C4A9AA2681517CC35AD9D.doentry
│ │ │ ├── 422BC895507944A291E6FC44FC6B8BFC.doentry
│ │ │ └── 4BB1F46946AD439996C9B59DE7C4DDC1.doentry
│ │ ├── dayone_empty.dayone/
│ │ │ └── entries/
│ │ │ └── empty.txt
│ │ ├── deletion.journal
│ │ ├── deletion_filters.journal
│ │ ├── empty_folder/
│ │ │ └── empty
│ │ ├── encrypted.journal
│ │ ├── encrypted_jrnl-1-9-5.journal
│ │ ├── little_endian_dates.journal
│ │ ├── markdown-headings-335.journal
│ │ ├── mostlyreadabledates.journal
│ │ ├── multiline-tags.journal
│ │ ├── multiline.journal
│ │ ├── simple.journal
│ │ ├── simple_jrnl-1-9-5.journal
│ │ ├── simple_jrnl-1-9-5_little_endian_dates.journal
│ │ ├── tags-216.journal
│ │ ├── tags-237.journal
│ │ ├── tags.journal
│ │ ├── unreadabledates.journal
│ │ └── work.journal
│ └── templates/
│ ├── basic.template
│ └── sample.template
├── lib/
│ ├── fixtures.py
│ ├── given_steps.py
│ ├── helpers.py
│ ├── then_steps.py
│ ├── type_builders.py
│ └── when_steps.py
└── unit/
├── test_color.py
├── test_config_file.py
├── test_controller.py
├── test_editor.py
├── test_export.py
├── test_install.py
├── test_journals_folder_journal.py
├── test_os_compat.py
├── test_output.py
├── test_override.py
├── test_parse_args.py
├── test_path.py
└── test_time.py
================================================
FILE CONTENTS
================================================
================================================
FILE: .build/allow_all_python_version.py
================================================
import toml
pyproject = toml.load("pyproject.toml")
pyproject["tool"]["poetry"]["dependencies"]["python"] = "*"
with open("pyproject.toml", "w") as toml_file:
toml.dump(pyproject, toml_file)
================================================
FILE: .gitattributes
================================================
*.journal text eol=lf
*.feature text eol=lf
poetry.lock text eol=lf
pyrpoject.toml text eol=lf
================================================
FILE: .github/FUNDING.yml
================================================
# These are supported funding model platforms
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: jrnl
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.yaml
================================================
name: Bug Report
description: Create a report to help us improve
title: "Bug Report"
labels: [ ":new:", "bug" ]
body:
- type: markdown
attributes:
value: |
# Bug Report
Hello, and thank you for reporting an issue!
Please fill out the points below, as it will make our process much easier.
- type: textarea
id: diagnostic
attributes:
label: Diagnostic output
description: Run `jrnl --diagnostic` and paste the output below
placeholder: Paste output here
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Please put a short description of what is currently happening.
placeholder: Tell us what is happening
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Please write a short description of what you would expect to happen
placeholder: Tell us what should be happening
validations:
required: true
- type: textarea
id: repro-steps
attributes:
label: Repro Steps
description: |
Provide the steps to reproduce the problem.
Please be as precise as possible, since more info will let us help you faster.
placeholder: Repro steps
validations:
required: true
- type: textarea
id: debug-output
attributes:
label: Debug output
description: |
Please provide the output of your command with the `--debug` flag on.
placeholder: "example: `jrnl --debug lorem ipsum`"
validations:
required: true
- type: textarea
id: other-info
attributes:
label: Other Information
description: >
Is there anything else we should know?
(e.g. more detailed explanation, stacktraces, related
issues, suggestions how to fix, links for us to have context, eg.
stackoverflow, gitter, etc)
validations:
required: false
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: false
================================================
FILE: .github/ISSUE_TEMPLATE/documentation.yaml
================================================
name: Documentation Change
description: Request or report any updates to our documentation (https://jrnl.sh)
title: Documentation Change
labels: [ ":new:", "documentation" ]
body:
- type: markdown
attributes:
value: |
# Documentation Change
Hello, and thank you for reporting an issue!
Please fill out the points below, as it will make our process much easier.
- type: textarea
id: affected-pages
attributes:
label: Affected Page(s)
description: >
Please tell us which page, or pages, from the documentation site
(https://jrnl.sh) are affected in this issue
placeholder: "example: https://jrnl.sh/en/stable/overview"
validations:
required: true
- type: textarea
id: what-could-be-better
attributes:
label: What Could Be Better?
description: >
Please write a short description of what you hope can be clarified or
further explained.
validations:
required: true
- type: textarea
id: other-info
attributes:
label: Other Information
description: Is there anything else we should know that might be helpful?
validations:
required: false
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.yaml
================================================
name: Feature Request
description: Suggest an idea for jrnl
title: "Feature Report"
labels: [ ":new:", "enhancement" ]
body:
- type: markdown
attributes:
value: |
# Feature Request
Hello, and thank you for reporting an issue!
Please fill out the points below, as it will make our process much easier.
- type: textarea
id: user-case
attributes:
label: Use Case/Motivation
description: What is the motivation / use case for changing the behavior?
placeholder: Tell us about your idea
validations:
required: true
- type: textarea
id: example-usage
attributes:
label: Example Usage
description: Please provide examples of the usage you would like to see.
placeholder: e.g `jrnl --new-flag="super cool new feature"`
validations:
required: true
- type: textarea
id: other-info
attributes:
label: Other Information
description: >
Is there anything else we should know?
(e.g. more detailed explanation, stacktraces, related
issues, suggestions how to fix, links for us to have context, eg.
stackoverflow, gitter, etc)
validations:
required: false
================================================
FILE: .github/ISSUE_TEMPLATE/support_request.yaml
================================================
name: Support Request
description: Get help with jrnl
title: Support Request
labels: [ ":new:", "support" ]
body:
- type: markdown
attributes:
value: |
# Support Request
Hello, and thank you for reporting an issue!
Please fill out the points below, as it will make our process much easier.
- type: textarea
id: diagnostic
attributes:
label: Diagnostic output
description: Run `jrnl --diagnostic` and paste the output below
placeholder: Paste output here
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: What are you trying to do?
description: Please put a short description of what is happening.
placeholder: Tell us what is happening
validations:
required: true
- type: textarea
id: tried
attributes:
label: What have you tried?
description: >
Have you tried anything to fix the problem? This can help give us more
information to help you with.
placeholder: Tell us what should be happening
validations:
required: true
- type: textarea
id: other-info
attributes:
label: Other Information
description: >
Is there anything else we should know?
(e.g. more detailed explanation, stacktraces, related
issues, suggestions how to fix, links for us to have context, eg.
stackoverflow, gitter, etc)
validations:
required: false
================================================
FILE: .github/PULL_REQUEST_TEMPLATE.md
================================================
<!--
Thank you for wanting to contribute!
Please fill out this description, and the checklist below.
Here are some key points to include in your description:
- What is this new code intended to do?
- Are there any related issues?
- What is the motivation for this change?
- What is an example of usage, or changes to config files? (if applicable)
-->
### Checklist
- [ ] I have read the [contributing doc](https://github.com/jrnl-org/jrnl/blob/develop/docs/contributing.md).
- [ ] I have included a link to the relevant issue number.
- [ ] I have checked to ensure there aren't other open [pull requests](../pulls)
for the same issue.
- [ ] I have written new tests for these changes, as needed.
<!--
NOTE: Your PR may not be reviewed if there are any failing tests. You can run
tests locally with `poe test` (see the contributing doc if you need help with
`poe`), or use our automated tests after you submit your PR.
-->
================================================
FILE: .github/actionlint-matcher.json
================================================
{
"problemMatcher": [
{
"owner": "actionlint",
"pattern": [
{
"regexp": "^(?:\\x1b\\[\\d+m)?(.+?)(?:\\x1b\\[\\d+m)*:(?:\\x1b\\[\\d+m)*(\\d+)(?:\\x1b\\[\\d+m)*:(?:\\x1b\\[\\d+m)*(\\d+)(?:\\x1b\\[\\d+m)*: (?:\\x1b\\[\\d+m)*(.+?)(?:\\x1b\\[\\d+m)* \\[(.+?)\\]$",
"file": 1,
"line": 2,
"column": 3,
"message": 4,
"code": 5
}
]
}
]
}
================================================
FILE: .github/actions/run_tests/action.yaml
================================================
name: run jrnl tests
description: Runs all jrnl tests on multiple platforms
inputs:
cache-string:
description: 'Cache string secret. Change to bust the cache'
required: true
runs:
using: "composite"
steps:
- run: git config --global core.autocrlf false
shell: bash
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
- name: Capture full Python version in env
run: echo "PYTHON_FULL_VERSION=$(python --version)" >> $GITHUB_ENV
shell: bash
- name: poetry cache # Change CACHE_STRING secret to bust the cache
uses: actions/cache@v5
with:
path: .venv
key: ${{ runner.os }}-${{ hashFiles('poetry.lock') }}-${{ env.PYTHON_FULL_VERSION }}-${{ inputs.cache-string }}
- name: Install dependencies
run: |
echo '::group::poetry'
pip --disable-pip-version-check install poetry
poetry config --local virtualenvs.in-project true
echo '::endgroup::'
echo '::group::Other dependencies'
poetry sync
echo '::endgroup::'
echo 'DEPS_INSTALLED=true' >> $GITHUB_ENV
shell: bash
- name: Linting & Testing
if: ${{ env.DEPS_INSTALLED == 'true' }}
run: poetry run poe test
shell: bash
================================================
FILE: .github/lock.yml
================================================
# Configuration for Lock Threads - https://github.com/dessant/lock-threads-app
# Number of days of inactivity before a closed issue or pull request is locked
daysUntilLock: 90
# Skip issues and pull requests created before a given timestamp. Timestamp must
# follow ISO 8601 (`YYYY-MM-DD`). Set to `false` to disable
skipCreatedBefore: false
# Issues and pull requests with these labels will be ignored. Set to `[]` to disable
exemptLabels: []
# Label to add before locking, such as `outdated`. Set to `false` to disable
lockLabel: ':lock:'
# Comment to post before locking. Set to `false` to disable
lockComment: >
This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs. You can link back here from your new issue to continue
the conversation.
# Assign `resolved` as the reason for locking. Set to `false` to disable
setLockReason: true
# Limit to only `issues` or `pulls`
# only: issues
# Optionally, specify configuration settings just for `issues` or `pulls`
# issues:
# exemptLabels:
# - help-wanted
# lockLabel: outdated
# pulls:
# daysUntilLock: 30
# Repository to extend settings from
# _extends: repo
================================================
FILE: .github/renovate.json
================================================
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base"
],
"schedule": [ "at any time" ],
"prConcurrentLimit": 10,
"prHourlyLimit": 10,
"reviewers": [
"wren",
"micahellison"
],
"labels": [ "packaging" ]
}
================================================
FILE: .github/stale.yml
================================================
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 60
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 7
# Issues with these labels will never be considered stale
exemptLabels:
- ':pushpin:'
- critical
# Label to use when marking an issue as stale
staleLabel: stale
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
================================================
FILE: .github/workflows/changelog.yaml
================================================
# Copyright © 2012-2023 jrnl contributors
# License: https://www.gnu.org/licenses/gpl-3.0.html
name: Changelog
on:
push:
branches:
- develop
tags:
- 'v*'
jobs:
generate:
if: >
! contains(github.event.head_commit.message, '[ci skip]') &&
! (
startsWith(github.event.head_commit.message, 'Increment version to v') &&
startsWith(github.ref, 'refs/heads/')
)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
token: ${{ secrets.JRNL_BOT_TOKEN }}
- name: Check branch for new commits, and env vars
run: |
echo "::group::git fetch origin --tags --force"
git fetch origin --tags --force
echo "::endgroup::"
TAG_REGEX='include-all'
echo "::debug::GITHUB_REF: $GITHUB_REF"
BRANCH="${GITHUB_REF##*/}"
if [[ $GITHUB_REF =~ ^refs/tags/ ]]; then
# This is a tag build (i.e. a release)
echo '::debug::Release build'
if [[ ! $BRANCH =~ ^v[0-9]+(\.[0-9]+){1,2}(-(alpha|beta)([0-9]+)?)?$ ]]; then
echo "::error::Invalid tag format: ${BRANCH}"
exit 1
fi
RELEASE=1
BRANCH=develop
git checkout $BRANCH
# if actual release (not pre), then changelog should exclude prereleases on update
prerelease_regex='(alpha|beta)'
if [[ ! ${GITHUB_REF##*/} =~ $prerelease_regex ]]; then
echo '::debug::Actual release (not a prerelease)'
TAG_REGEX="$prerelease_regex"
echo "FULL_RELEASE=true" >> "$GITHUB_ENV"
fi
fi
echo "::debug::TAG_REGEX: $TAG_REGEX"
if [[ "$(git rev-parse "origin/$BRANCH")" != "$GITHUB_SHA" ]]; then
# Normal build on a branch (no tag)
echo "::debug::BRANCH: $BRANCH $(git rev-parse "origin/$BRANCH")"
echo "::debug::GITHUB_SHA: $GITHUB_SHA"
echo "::error::$BRANCH has been updated since build started. Aborting changelog."
exit 1
fi
SINCE_TAG=$(git tag --sort=-creatordate | grep -Ev "$TAG_REGEX" | awk "NR==$(( 1 + ${RELEASE:-0} ))")
echo "::debug::BRANCH: $BRANCH"
echo "::debug::TAG_REGEX: $TAG_REGEX"
echo "::debug::FILENAME: CHANGELOG.md"
echo "::debug::SINCE_TAG: $SINCE_TAG"
{
echo "BRANCH=$BRANCH"
echo "TAG_REGEX=$TAG_REGEX"
echo "FILENAME=CHANGELOG.md"
echo "SINCE_TAG=$SINCE_TAG"
} >> "$GITHUB_ENV"
- name: Prep changelog file (clear out old lines)
run: |
# delete the top of the changelog up to the correct tag
tagline=$(grep -n "^## \[${SINCE_TAG}\]" "$FILENAME" | awk '{print $1}' FS=':' | head -1)
echo "tagline: ${tagline}"
if [[ -z $tagline ]]; then
echo "::error::Something is wrong. ${SINCE_TAG} isn't in the changelog."
exit 1
fi
if [[ $tagline == 1 ]]; then
echo "::error::Something is wrong."
echo "::error::The latest release ${SINCE_TAG} is the first line in the changelog,"
echo "::error::but the h1 '# Changelog' should always be the first line."
exit 1
fi
sed -i "1,$(( tagline - 1 ))d" "$FILENAME"
# delete generated line (or it will be added multiple times)
sed -i '/This Changelog was automatically generated by/d' "$FILENAME"
# delete trailing empty lines
sed -i -e :a -e '/^\n*$/{$d;N;};/\n$/ba' "$FILENAME"
- name: Generate changelog
uses: heinrichreimer/action-github-changelog-generator@v2.1.1
with:
# see: https://github.com/heinrichreimer/action-github-changelog-generator
repo: jrnl-org/jrnl
token: ${{ secrets.JRNL_BOT_TOKEN }}
base: CHANGELOG.md
addSections: '{"build":{"prefix":"**Build:**","labels":["build"]},"docs":{"prefix":"**Documentation:**","labels":["documentation"]},"packaging":{"prefix":"**Packaging:**","labels":["packaging"]}}'
issues: true
pullRequests: true
issuesWoLabels: false
unreleased: true
compareLink: true
includeLabels: bug,enhancement,documentation,build,packaging,deprecated
excludeLabels: stale,wontfix
excludeTagsRegex: ${{ env.TAG_REGEX }}
sinceTag: ${{ env.SINCE_TAG }}
maxIssues: 150
releaseUrl: https://pypi.org/project/jrnl/%s/
releaseBranch: develop
verbose: false
author: true
- name: Small fixes
run: |
# Change unreleased link to correct url
sed -i 's!https://pypi.org/project/jrnl/HEAD/!https://github.com/jrnl-org/jrnl/!' "$FILENAME"
- name: Diff and consistency check
run: |
git diff
if [[ $(grep -c '^# Changelog$' "$FILENAME") != 1 ]]; then
echo '::error::Something is wrong with the changelog.'
exit 1
fi
SOMETHING_CHANGED=false
git diff --exit-code || SOMETHING_CHANGED=true
echo "::debug::SOMETHING_CHANGED: $SOMETHING_CHANGED"
echo "SOMETHING_CHANGED=$SOMETHING_CHANGED" >> "$GITHUB_ENV"
- name: Commit
if: env.SOMETHING_CHANGED == 'true'
run: |
git config --global user.name "${{ secrets.JRNL_BOT_NAME }}"
git config --global user.email "${{ secrets.JRNL_BOT_EMAIL }}"
git add "$FILENAME"
git commit -m "Update changelog [ci skip]"
git push origin "$BRANCH"
- name: Update tag to include changelog
if: startsWith(env.GITHUB_REF, 'refs/tags/')
run: |
# This is a tag build (releases and prereleases)
# update the tag to include the changelog
git tag -fam "$GITHUB_REF_NAME" "$GITHUB_REF_NAME"
git push --tags --force
- name: Merge to Release branch
if: env.FULL_RELEASE == 'true'
run: |
git fetch --unshallow origin
git checkout release
git merge --ff-only "$BRANCH"
git push origin release
================================================
FILE: .github/workflows/docs.yaml
================================================
# Copyright © 2012-2023 jrnl contributors
# License: https://www.gnu.org/licenses/gpl-3.0.html
name: Docs
on:
push:
branches: [ develop, release ]
paths:
- 'docs/**'
- 'docs_theme/**'
- 'mkdocs.yml'
- 'readthedocs.yml'
- '.github/workflows/docs.yaml'
- 'tasks.py'
- 'pyproject.toml'
pull_request:
branches: [ develop ]
paths:
- 'docs/**'
- 'docs_theme/**'
- 'mkdocs.yml'
- 'readthedocs.yml'
- '.github/workflows/docs.yaml'
- 'tasks.py'
- 'pyproject.toml'
jobs:
accessibility:
if: contains(toJson(github.event.commits), '[ci skip]') == false
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
python-version: [ '3.11' ]
os: [ ubuntu-latest ]
steps:
- uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Setup Node.js environment
uses: actions/setup-node@main
- name: Capture full Python version in env
run: echo "PYTHON_FULL_VERSION=$(python --version)" >> "$GITHUB_ENV"
- name: poetry cache
uses: actions/cache@v5
with:
path: .venv
key: ${{ runner.os }}-${{ hashFiles('poetry.lock') }}-${{ env.PYTHON_FULL_VERSION }}-${{ secrets.CACHE_STRING }}
- name: npm cache
uses: actions/cache@v5
with:
path: node_modules
key: ${{ runner.os }}-pa11y-cache-${{ secrets.CACHE_STRING }}
- name: puppeteer cache for pa11y
uses: actions/cache@v5
with:
path: home/runner/.cache/puppeteer
key: ${{ runner.os }}-puppeteer-cache-${{ secrets.CACHE_STRING }}
- name: Install dependencies
run: |
pip install poetry
poetry config --local virtualenvs.in-project true
poetry sync --no-root
npm install
npx puppeteer browsers install chrome
echo "node_modules/.bin" >> "$GITHUB_PATH"
- name: Start docs server
run: poetry run poe docs-run &
- name: Accessibility testing (Pa11y)
run: poetry run poe docs-check
================================================
FILE: .github/workflows/release.yaml
================================================
# Copyright © 2012-2023 jrnl contributors
# License: https://www.gnu.org/licenses/gpl-3.0.html
name: Release
on:
workflow_dispatch:
inputs:
version:
description: 'Version (e.g. v2.5, v2.5.1-beta, v2.6-beta2)'
type: string
required: true
include_repo_version:
description: 'Update version in repo?'
type: boolean
required: true
default: true
include_pypi:
description: 'Publish to PyPI?'
type: boolean
required: true
default: true
jobs:
validate:
name: "Validate version string"
runs-on: ubuntu-latest
steps:
- name: Validate version
run: |
JRNL_VERSION="${{ github.event.inputs.version }}"
echo "::debug::version: $JRNL_VERSION"
if [[ ! $JRNL_VERSION =~ ^v[0-9]+(\.[0-9]+){1,2}(-(alpha|beta)([0-9]+)?)?$ ]]; then
echo
echo "::error::Bad version"
echo
echo "Version string should match pattern above."
echo "Here are some examples of valid version numbers:"
echo
echo " v2.5"
echo " v2.5-alpha"
echo " v2.5-beta"
echo " v2.5.1"
echo " v2.5.1-alpha"
echo " v2.5.1-beta"
exit 1
fi
release_pypi:
needs: validate
name: "Release to PyPI"
runs-on: ubuntu-latest
outputs:
pypi_version: ${{ steps.pypi-version-getter.outputs.pypi_version }}
env:
HOME_REPO: ${{ secrets.HOME_REPO }}
steps:
- name: Get version
run: |
JRNL_VERSION="${{ github.event.inputs.version }}"
echo "::debug::version: $JRNL_VERSION"
echo "JRNL_VERSION=$JRNL_VERSION" >> "$GITHUB_ENV"
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.14'
- name: Checkout repo
uses: actions/checkout@v6
with:
token: ${{ secrets.JRNL_BOT_TOKEN }}
- name: Config git user
run: |
git config --global user.name "${{ secrets.JRNL_BOT_NAME }}"
git config --global user.email "${{ secrets.JRNL_BOT_EMAIL }}"
- name: Install dependencies
run: pip install poetry
- name: Update version in files
if: ${{ github.event.inputs.include_repo_version == 'true' }}
run: |
poetry version "$JRNL_VERSION"
echo "__version__ = \"$JRNL_VERSION\"" > jrnl/__version__.py
- name: Commit updated files
if: ${{ github.event.inputs.include_repo_version == 'true' && github.repository == env.HOME_REPO }}
run: |
git add pyproject.toml jrnl/__version__.py
git commit -m "Increment version to ${JRNL_VERSION}"
git tag -a -m "$JRNL_VERSION" "$JRNL_VERSION"
git push
git push --tags
- name: Build
run: poetry build
- name: Deploy to PyPI
if: ${{ github.event.inputs.include_pypi == 'true' && github.repository == env.HOME_REPO }}
env:
POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
run: poetry publish
- name: Get PyPI version
id: pypi-version-getter
run: |
pypi_version="$(find dist/jrnl-*.tar.gz | sed -r 's!dist/jrnl-(.*)\.tar\.gz!\1!')"
echo "pypi_version=$pypi_version" >> "$GITHUB_OUTPUT"
================================================
FILE: .github/workflows/testing_pipelines.yaml
================================================
# Copyright © 2012-2023 jrnl contributors
# License: https://www.gnu.org/licenses/gpl-3.0.html
name: Testing Pipeline Files
on:
push:
branches: [ develop, release ]
paths:
- '.github/workflows/**'
- '.github/actions/**'
pull_request:
branches: [ develop ]
paths:
- '.github/workflows/**'
- '.github/actions/**'
schedule:
- cron: '0 0 * * SAT'
jobs:
test:
if: >
! contains(github.event.head_commit.message, '[ci skip]')
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ ubuntu-latest ]
steps:
- run: git config --global core.autocrlf false
- uses: actions/checkout@v6
- name: Check workflow files
uses: docker://rhysd/actionlint:latest
with:
args: -color
================================================
FILE: .github/workflows/testing_prs.yaml
================================================
# Copyright © 2012-2023 jrnl contributors
# License: https://www.gnu.org/licenses/gpl-3.0.html
name: Testing
on:
push:
branches: [ develop, release ]
paths:
- 'jrnl/**'
- 'features/**'
- 'tests/**'
- 'poetry.lock'
- 'pyproject.toml'
- '.github/workflows/testing_prs.yaml'
- 'tasks.py'
pull_request:
branches: [ develop ]
paths:
- 'jrnl/**'
- 'features/**'
- 'tests/**'
- 'poetry.lock'
- 'pyproject.toml'
- '.github/workflows/testing_prs.yaml'
- 'tasks.py'
defaults:
run:
shell: bash # needed to prevent Windows from using PowerShell
jobs:
test:
if: >
! contains(github.event.head_commit.message, '[ci skip]')
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
os: [ ubuntu-latest, macos-latest, windows-latest ]
steps:
- run: git config --global core.autocrlf false
- uses: actions/checkout@v6
- name: Run tests
uses: ./.github/actions/run_tests
with:
cache-string: ${{ secrets.CACHE_STRING }}
================================================
FILE: .github/workflows/testing_schedule.yaml
================================================
# Copyright © 2012-2023 jrnl contributors
# License: https://www.gnu.org/licenses/gpl-3.0.html
name: Testing
on:
schedule:
- cron: '0 0 * * SAT'
defaults:
run:
shell: bash # needed to prevent Windows from using PowerShell
jobs:
test_all:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
os: [ ubuntu-latest, macos-latest, windows-latest ]
steps:
- run: git config --global core.autocrlf false
- uses: actions/checkout@v6
- name: Run tests
uses: ./.github/actions/run_tests
with:
cache-string: ${{ secrets.CACHE_STRING }}
================================================
FILE: .gitignore
================================================
# Byte-compiled DLL and Shared Library files
*.py[cod]
*.so
# Packages
*.egg
*.egg-info/
.installed.cfg
bin/
build/
develop-eggs/
dist/
eggs/
lib64/
parts/
sdist/
.tox/
var/
node_modules/
__pycache__/
.pytest_cache/
.flakeheaven_cache/
# Versioning
.python-version
.tool-versions
# Installer logs
.DS_Store
.travis-solo
Icon
pip-log.txt
# Documentation
_build
_sources
_static
coverage.xml
exp/
objects.inv
searchindex.js
# virtualenv
.venv*/
env/
env*/
venv*/
# Editor and IDE specific files
# Since contributors may want to user a variety of development tools it is
# recommended that editor specific file types be ignored globally by each
# contributor via a global gitignore. Instructions for setting up a global
# ignore file can be found here:
# https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files
# (Configuring ignored files for all repositories on your computer)
# Examples of such files are:
# MS Visual Studio (PyTools)
# obj
# *.suo
# PyCharm
# .idea/
# VS Code
# .vscode/settings.json
================================================
FILE: .readthedocs.yaml
================================================
# readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS
build:
os: ubuntu-22.04
tools:
python: "3"
# Build documentation in the docs/ directory
mkdocs:
configuration: mkdocs.yml
fail_on_warning: false
# Optionally build your docs in additional formats such as PDF
formats:
- pdf
- epub
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs_theme/requirements.txt
================================================
FILE: CHANGELOG.md
================================================
# Changelog
## [v4.3](https://pypi.org/project/jrnl/v4.3/) (2026-02-24)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.3-beta...v4.3)
**Build:**
- Modernize pyproject [\#2046](https://github.com/jrnl-org/jrnl/pull/2046) ([micahellison](https://github.com/micahellison))
- Remove release step to publish to Homebrew [\#1994](https://github.com/jrnl-org/jrnl/pull/1994) ([micahellison](https://github.com/micahellison))
**Documentation:**
- Doc missing: Setting location of journal [\#2019](https://github.com/jrnl-org/jrnl/issues/2019)
- \[Documentation change\] Update command line reference [\#2032](https://github.com/jrnl-org/jrnl/pull/2032) ([katielin019](https://github.com/katielin019))
- Add example of how to configure location of a journal [\#2020](https://github.com/jrnl-org/jrnl/pull/2020) ([matthiasbeyer](https://github.com/matthiasbeyer))
**Packaging:**
- Update actions/checkout action to v6 [\#2053](https://github.com/jrnl-org/jrnl/pull/2053) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/cache action to v5 [\#2052](https://github.com/jrnl-org/jrnl/pull/2052) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to \>=14.3.2,\<14.4.0 [\#2051](https://github.com/jrnl-org/jrnl/pull/2051) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency python to 3.14 [\#2050](https://github.com/jrnl-org/jrnl/pull/2050) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/setup-python action to v6 [\#2031](https://github.com/jrnl-org/jrnl/pull/2031) ([renovate[bot]](https://github.com/apps/renovate))
- Add support for Python 3.14 [\#2015](https://github.com/jrnl-org/jrnl/pull/2015) ([micahellison](https://github.com/micahellison))
- Update dependency pa11y-ci to v4 [\#2014](https://github.com/jrnl-org/jrnl/pull/2014) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to \>=14.1.0, \<14.2.0 [\#2013](https://github.com/jrnl-org/jrnl/pull/2013) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency requests to v2.32.4 [\#2010](https://github.com/jrnl-org/jrnl/pull/2010) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest to v8.4.1 [\#2009](https://github.com/jrnl-org/jrnl/pull/2009) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-xdist to v3.8.0 [\#2005](https://github.com/jrnl-org/jrnl/pull/2005) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruamel.yaml to v0.18.14 [\#2004](https://github.com/jrnl-org/jrnl/pull/2004) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency cryptography to v45 [\#2001](https://github.com/jrnl-org/jrnl/pull/2001) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.28.3 [\#2000](https://github.com/jrnl-org/jrnl/pull/2000) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.36.0 [\#1993](https://github.com/jrnl-org/jrnl/pull/1993) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruff to v0.12.5 [\#1991](https://github.com/jrnl-org/jrnl/pull/1991) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to v14 [\#1989](https://github.com/jrnl-org/jrnl/pull/1989) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency python to 3.13 [\#1988](https://github.com/jrnl-org/jrnl/pull/1988) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.25.0 [\#1986](https://github.com/jrnl-org/jrnl/pull/1986) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tzlocal to v5.3.1 [\#1984](https://github.com/jrnl-org/jrnl/pull/1984) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency jinja2 to v3.1.6 [\#1983](https://github.com/jrnl-org/jrnl/pull/1983) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.33.1 [\#1982](https://github.com/jrnl-org/jrnl/pull/1982) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest to v8.3.5 [\#1981](https://github.com/jrnl-org/jrnl/pull/1981) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency cryptography to v44.0.2 [\#1980](https://github.com/jrnl-org/jrnl/pull/1980) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruff to v0.11.3 [\#1978](https://github.com/jrnl-org/jrnl/pull/1978) ([renovate[bot]](https://github.com/apps/renovate))
## [v4.2.1](https://pypi.org/project/jrnl/v4.2.1/) (2025-02-25)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.2...v4.2.1)
**Documentation:**
- Typing animation in landing page is broken [\#1969](https://github.com/jrnl-org/jrnl/issues/1969)
**Packaging:**
- Update dependency pytest to \>=8.1.1 [\#1974](https://github.com/jrnl-org/jrnl/pull/1974) ([wren](https://github.com/wren))
- Update dependency black to v25 [\#1973](https://github.com/jrnl-org/jrnl/pull/1973) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tzlocal to v5.3 [\#1972](https://github.com/jrnl-org/jrnl/pull/1972) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruamel.yaml to v0.18.10 [\#1967](https://github.com/jrnl-org/jrnl/pull/1967) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency jinja2 to v3.1.5 [\#1966](https://github.com/jrnl-org/jrnl/pull/1966) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency cryptography to v44 [\#1962](https://github.com/jrnl-org/jrnl/pull/1962) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-bdd to v8.1.0 [\#1952](https://github.com/jrnl-org/jrnl/pull/1952) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.32.2 [\#1951](https://github.com/jrnl-org/jrnl/pull/1951) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency keyring to v25.6.0 [\#1948](https://github.com/jrnl-org/jrnl/pull/1948) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruff to v0.9.7 [\#1947](https://github.com/jrnl-org/jrnl/pull/1947) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to v13.9.4 [\#1946](https://github.com/jrnl-org/jrnl/pull/1946) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.24.1 [\#1945](https://github.com/jrnl-org/jrnl/pull/1945) ([renovate[bot]](https://github.com/apps/renovate))
## [v4.2](https://pypi.org/project/jrnl/v4.2/) (2024-11-17)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.2-beta...v4.2)
**Implemented enhancements:**
- Add Python 3.13 support [\#1893](https://github.com/jrnl-org/jrnl/issues/1893)
- Add calendar heatmap display format [\#1759](https://github.com/jrnl-org/jrnl/pull/1759) ([alichtman](https://github.com/alichtman))
**Fixed bugs:**
- -contains doesn't accept multiple search terms, doesn't work with -and [\#1877](https://github.com/jrnl-org/jrnl/issues/1877)
- Tests failing on develop branch starting with pytest-bdd 7.1.2 [\#1875](https://github.com/jrnl-org/jrnl/issues/1875)
- Ignore color when used in a pipeline [\#1839](https://github.com/jrnl-org/jrnl/issues/1839)
- Fix -contains to allow multiple terms with "OR" logic unless -and is added [\#1890](https://github.com/jrnl-org/jrnl/pull/1890) ([eigenric](https://github.com/eigenric))
**Documentation:**
- Recommend pipx as default installation method [\#1888](https://github.com/jrnl-org/jrnl/issues/1888)
- Remove documentation recommendation to install pipx through brew or pip [\#1886](https://github.com/jrnl-org/jrnl/issues/1886)
- Document security risks of using a computer that someone else has admin access to [\#1793](https://github.com/jrnl-org/jrnl/issues/1793)
- Recommend pipx as easiest installation method for all OSes and remove warning about apt [\#1889](https://github.com/jrnl-org/jrnl/pull/1889) ([micahellison](https://github.com/micahellison))
- Docs accessibility checker failure - contrast ratio [\#1934](https://github.com/jrnl-org/jrnl/issues/1934)
- Docs accessibility test runner failing [\#1932](https://github.com/jrnl-org/jrnl/issues/1932)
**Packaging:**
- Update actions/cache action to v4 [\#1847](https://github.com/jrnl-org/jrnl/pull/1847) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/setup-python action to v5 [\#1848](https://github.com/jrnl-org/jrnl/pull/1848) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency black to v24.8.0 [\#1923](https://github.com/jrnl-org/jrnl/pull/1923) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency cryptography to v43.0.3 [\#1942](https://github.com/jrnl-org/jrnl/pull/1942) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency jinja2 to v3.1.4 [\#1892](https://github.com/jrnl-org/jrnl/pull/1892) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency keyring to v25.4.1 [\#1924](https://github.com/jrnl-org/jrnl/pull/1924) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency mkdocs to v1.6.1 [\#1895](https://github.com/jrnl-org/jrnl/pull/1895) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pa11y-ci to v3.1.0 [\#1831](https://github.com/jrnl-org/jrnl/pull/1831) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency parse-type to v0.6.4 [\#1936](https://github.com/jrnl-org/jrnl/pull/1936) ([renovate[bot]](https://github.com/apps/renovate))
- Update peter-evans/create-pull-request action to v7 [\#1929](https://github.com/jrnl-org/jrnl/pull/1929) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.29.0 [\#1925](https://github.com/jrnl-org/jrnl/pull/1925) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest to v7.4.4 [\#1845](https://github.com/jrnl-org/jrnl/pull/1845) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-bdd to v7.3.0 [\#1896](https://github.com/jrnl-org/jrnl/pull/1896) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-xdist to v3.6.1 [\#1897](https://github.com/jrnl-org/jrnl/pull/1897) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency python-dateutil to v2.9.0 [\#1898](https://github.com/jrnl-org/jrnl/pull/1898) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency requests to v2.32.3 [\#1899](https://github.com/jrnl-org/jrnl/pull/1899) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to v13.9.2 [\#1937](https://github.com/jrnl-org/jrnl/pull/1937) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruamel.yaml to v0.18.6 [\#1855](https://github.com/jrnl-org/jrnl/pull/1855) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruff to v0.7.0 [\#1938](https://github.com/jrnl-org/jrnl/pull/1938) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.23.0 [\#1935](https://github.com/jrnl-org/jrnl/pull/1935) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency typed.js to v2.1.0 [\#1861](https://github.com/jrnl-org/jrnl/pull/1861) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency xmltodict to v0.14.2 [\#1940](https://github.com/jrnl-org/jrnl/pull/1940) ([renovate[bot]](https://github.com/apps/renovate))
- Update nick-invision/retry action to v3 [\#1851](https://github.com/jrnl-org/jrnl/pull/1851) ([renovate[bot]](https://github.com/apps/renovate))
- Update peter-evans/create-pull-request action to v6 [\#1852](https://github.com/jrnl-org/jrnl/pull/1852) ([renovate[bot]](https://github.com/apps/renovate))
## [v4.1](https://pypi.org/project/jrnl/v4.1/) (2023-11-04)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.1-beta2...v4.1)
**Build:**
- Add Python 3.12 support [\#1761](https://github.com/jrnl-org/jrnl/pull/1761) ([micahellison](https://github.com/micahellison))
- Set new required build fields in the ReadTheDocs config file [\#1803](https://github.com/jrnl-org/jrnl/pull/1803) ([micahellison](https://github.com/micahellison))
- Replace flake8 and isort with ruff linter and add `black --check` to linting step [\#1763](https://github.com/jrnl-org/jrnl/pull/1763) ([micahellison](https://github.com/micahellison))
**Documentation:**
- Add note about messages going to `stderr` and the implication for piping [\#1768](https://github.com/jrnl-org/jrnl/pull/1768) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Drop/replace ansiwrap dependency [\#1191](https://github.com/jrnl-org/jrnl/issues/1191)
- Use rich instead of ansiwrap to wrap text [\#1693](https://github.com/jrnl-org/jrnl/pull/1693) ([micahellison](https://github.com/micahellison))
- Update actions/checkout action to v4 [\#1788](https://github.com/jrnl-org/jrnl/pull/1788) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency black to v23.10.1 [\#1811](https://github.com/jrnl-org/jrnl/pull/1811) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency cryptography to v41.0.5 [\#1815](https://github.com/jrnl-org/jrnl/pull/1815) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency keyring to v24.2.0 [\#1760](https://github.com/jrnl-org/jrnl/pull/1760) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency mkdocs to v1.5.3 [\#1795](https://github.com/jrnl-org/jrnl/pull/1795) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency parse-type to v0.6.2 [\#1762](https://github.com/jrnl-org/jrnl/pull/1762) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.24.1 [\#1806](https://github.com/jrnl-org/jrnl/pull/1806) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest to v7.4.3 [\#1816](https://github.com/jrnl-org/jrnl/pull/1816) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-bdd to v7 [\#1807](https://github.com/jrnl-org/jrnl/pull/1807) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to v13.6.0 [\#1794](https://github.com/jrnl-org/jrnl/pull/1794) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruamel.yaml to v0.18.3 [\#1813](https://github.com/jrnl-org/jrnl/pull/1813) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruff to v0.1.3 [\#1810](https://github.com/jrnl-org/jrnl/pull/1810) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.11.3 [\#1782](https://github.com/jrnl-org/jrnl/pull/1782) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tzlocal to v5.2 [\#1814](https://github.com/jrnl-org/jrnl/pull/1814) ([renovate[bot]](https://github.com/apps/renovate))
**Special thanks:**
- jrnl uses UTC instead of local time for entries in WSL/Ubuntu [\#1607](https://github.com/jrnl-org/jrnl/issues/1607) investigated and reported upstream by [giuseppedandrea](https://github.com/giuseppedandrea)
## [v4.0.1](https://pypi.org/project/jrnl/v4.0.1/) (2023-06-20)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.0.1-beta...v4.0.1)
**Fixed bugs:**
- jrnl crashes when running `jrnl --list --format json` and `jrnl --list --format yaml` [\#1737](https://github.com/jrnl-org/jrnl/issues/1737)
- Refactor --template code [\#1711](https://github.com/jrnl-org/jrnl/pull/1711) ([micahellison](https://github.com/micahellison))
**Build:**
- Fix linting issue in CI pipeline [\#1743](https://github.com/jrnl-org/jrnl/pull/1743) ([wren](https://github.com/wren))
**Packaging:**
- Update dependency ruamel.yaml to v0.17.28 [\#1749](https://github.com/jrnl-org/jrnl/pull/1749) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency requests to v2.31.0 [\#1748](https://github.com/jrnl-org/jrnl/pull/1748) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ruamel.yaml to v0.17.26 [\#1746](https://github.com/jrnl-org/jrnl/pull/1746) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tzlocal to v5 [\#1741](https://github.com/jrnl-org/jrnl/pull/1741) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-xdist to v3.3.1 [\#1740](https://github.com/jrnl-org/jrnl/pull/1740) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.20.0 [\#1735](https://github.com/jrnl-org/jrnl/pull/1735) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency mkdocs to v1.4.3 [\#1733](https://github.com/jrnl-org/jrnl/pull/1733) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to v13.3.5 [\#1729](https://github.com/jrnl-org/jrnl/pull/1729) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency requests to v2.30.0 [\#1728](https://github.com/jrnl-org/jrnl/pull/1728) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.5.1 [\#1727](https://github.com/jrnl-org/jrnl/pull/1727) ([renovate[bot]](https://github.com/apps/renovate))
- Update peter-evans/create-pull-request action to v5 [\#1719](https://github.com/jrnl-org/jrnl/pull/1719) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency flake8-simplify to v0.20.0 [\#1716](https://github.com/jrnl-org/jrnl/pull/1716) ([renovate[bot]](https://github.com/apps/renovate))
## [v4.0](https://pypi.org/project/jrnl/v4.0/) (2023-05-20)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.0-beta3...v4.0)
🚨 **BREAKING CHANGES** 🚨
**Deprecated:**
- Drop Python 3.9 and use Python 3.11 official release [\#1611](https://github.com/jrnl-org/jrnl/pull/1611) ([micahellison](https://github.com/micahellison))
**Implemented enhancements:**
- Add message with config location and docs location when installation is complete [\#1695](https://github.com/jrnl-org/jrnl/pull/1695) ([micahellison](https://github.com/micahellison))
- Prompt to include colors in config when first running jrnl [\#1687](https://github.com/jrnl-org/jrnl/pull/1687) ([micahellison](https://github.com/micahellison))
- Add ability to use template with `--template` [\#1667](https://github.com/jrnl-org/jrnl/pull/1667) ([alichtman](https://github.com/alichtman))
- Search for entries with no tags or stars with `-not -starred` and `-not -tagged` [\#1663](https://github.com/jrnl-org/jrnl/pull/1663) ([cjcon90](https://github.com/cjcon90))
- Refactor flow for easier access to some files \(avoid things like `jrnl.Journal.Journal` and `jrnl.jrnl` co-existing\) [\#1662](https://github.com/jrnl-org/jrnl/pull/1662) ([wren](https://github.com/wren))
- Add more type hints [\#1642](https://github.com/jrnl-org/jrnl/pull/1642) ([outa](https://github.com/outa))
- Add `rich` handler to debug logging [\#1627](https://github.com/jrnl-org/jrnl/pull/1627) ([wren](https://github.com/wren))
- Rework Encryption to enable future support of other encryption methods [\#1602](https://github.com/jrnl-org/jrnl/pull/1602) ([wren](https://github.com/wren))
**Fixed bugs:**
- Only read text files that look like entries when opening folder journal [\#1697](https://github.com/jrnl-org/jrnl/pull/1697) ([micahellison](https://github.com/micahellison))
- Save empty journal on install instead of just creating a zero-length file [\#1690](https://github.com/jrnl-org/jrnl/pull/1690) ([micahellison](https://github.com/micahellison))
- Allow combinations of `--change-time`, `--delete`, and `--edit` while correctly counting the number of entries affected [\#1669](https://github.com/jrnl-org/jrnl/pull/1669) ([wren](https://github.com/wren))
- Don't save templated journal entries if the received raw text is the same as the template itself [\#1653](https://github.com/jrnl-org/jrnl/pull/1653) ([Briscoooe](https://github.com/Briscoooe))
- Add tag to XML file when edited DayOne entry and is searchable afterward [\#1648](https://github.com/jrnl-org/jrnl/pull/1648) ([jonakeys](https://github.com/jonakeys))
- Update version key in config file after version changes [\#1646](https://github.com/jrnl-org/jrnl/pull/1646) ([jonakeys](https://github.com/jonakeys))
**Build:**
- Update copyright notices for 2023 [\#1660](https://github.com/jrnl-org/jrnl/pull/1660) ([wren](https://github.com/wren))
- Fix bug where changelog is always slightly out of date on release tags [\#1631](https://github.com/jrnl-org/jrnl/pull/1631) ([wren](https://github.com/wren))
- Add `simplify` plugin to linting checks [\#1630](https://github.com/jrnl-org/jrnl/pull/1630) ([wren](https://github.com/wren))
- Add type hints [\#1614](https://github.com/jrnl-org/jrnl/pull/1614) ([outa](https://github.com/outa))
**Documentation:**
- Update contributing.md links in documentation [\#1726](https://github.com/jrnl-org/jrnl/pull/1726) ([ahosking](https://github.com/ahosking))
- Fix various typos [\#1718](https://github.com/jrnl-org/jrnl/pull/1718) ([hezhizhen](https://github.com/hezhizhen))
- Update documentation front page text [\#1698](https://github.com/jrnl-org/jrnl/pull/1698) ([micahellison](https://github.com/micahellison))
- Support mkdocs 1.4.2 and fix its missing breadcrumb [\#1691](https://github.com/jrnl-org/jrnl/pull/1691) ([micahellison](https://github.com/micahellison))
- Document temporary file extension behavior when using template [\#1686](https://github.com/jrnl-org/jrnl/pull/1686) ([micahellison](https://github.com/micahellison))
- Document `-tagged`, `-not -tagged`, and `-not -starred` [\#1684](https://github.com/jrnl-org/jrnl/pull/1684) ([micahellison](https://github.com/micahellison))
- Update documentation about privacy and security in VSCode [\#1680](https://github.com/jrnl-org/jrnl/pull/1680) ([giuseppedandrea](https://github.com/giuseppedandrea))
- Update documentation on temporary files naming [\#1673](https://github.com/jrnl-org/jrnl/pull/1673) ([giuseppedandrea](https://github.com/giuseppedandrea))
- Update docs to include time and title in arguments with `--edit` [\#1657](https://github.com/jrnl-org/jrnl/pull/1657) ([pconrad-fb](https://github.com/pconrad-fb))
- Fix markup in "Advanced Usage" doc [\#1655](https://github.com/jrnl-org/jrnl/pull/1655) ([multani](https://github.com/multani))
- Remove Windows 7 known issue since Windows 7 is no longer supported [\#1636](https://github.com/jrnl-org/jrnl/pull/1636) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Lock ruamel.yaml version to v0.17.21 until bug is fixed [\#1738](https://github.com/jrnl-org/jrnl/pull/1738) ([wren](https://github.com/wren))
- Update dependency black to v23.3.0 [\#1715](https://github.com/jrnl-org/jrnl/pull/1715) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency cryptography to v40.0.2 [\#1723](https://github.com/jrnl-org/jrnl/pull/1723) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency flake8-type-checking to v2.4.0 [\#1714](https://github.com/jrnl-org/jrnl/pull/1714) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency flakeheaven to v3.3.0 [\#1722](https://github.com/jrnl-org/jrnl/pull/1722) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency ipdb to v0.13.13 [\#1703](https://github.com/jrnl-org/jrnl/pull/1703) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency poethepoet to v0.19.0 [\#1709](https://github.com/jrnl-org/jrnl/pull/1709) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest to v7.3.1 [\#1720](https://github.com/jrnl-org/jrnl/pull/1720) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-xdist to v3.2.1 [\#1705](https://github.com/jrnl-org/jrnl/pull/1705) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency rich to v13.3.4 [\#1713](https://github.com/jrnl-org/jrnl/pull/1713) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tox to v4.4.7 [\#1707](https://github.com/jrnl-org/jrnl/pull/1707) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency tzlocal to v4.3 [\#1708](https://github.com/jrnl-org/jrnl/pull/1708) ([renovate[bot]](https://github.com/apps/renovate))
## [v3.3](https://pypi.org/project/jrnl/v3.3/) (2022-10-29)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.3-beta2...v3.3)
**Implemented enhancements:**
- Change default config to use journal key [\#1594](https://github.com/jrnl-org/jrnl/pull/1594) ([micahellison](https://github.com/micahellison))
- Add machine readable --list output [\#1592](https://github.com/jrnl-org/jrnl/pull/1592) ([apainintheneck](https://github.com/apainintheneck))
**Fixed bugs:**
- Fix bug for new `--list --format` options when no default journal is specified [\#1621](https://github.com/jrnl-org/jrnl/pull/1621) ([wren](https://github.com/wren))
- Don't create empty file when attempting a YAML export to a non-existing folder [\#1600](https://github.com/jrnl-org/jrnl/pull/1600) ([outa](https://github.com/outa))
**Build:**
- Update `.gitignore` [\#1604](https://github.com/jrnl-org/jrnl/pull/1604) ([wren](https://github.com/wren))
- Fix Docs Accessibility Testing [\#1588](https://github.com/jrnl-org/jrnl/pull/1588) ([wren](https://github.com/wren))
- Update to use renamed flag for `brew bump-formula-pr` [\#1587](https://github.com/jrnl-org/jrnl/pull/1587) ([wren](https://github.com/wren))
- Update peter-evans/create-pull-request action to v4 [\#1585](https://github.com/jrnl-org/jrnl/pull/1585) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/setup-python action to v4 [\#1583](https://github.com/jrnl-org/jrnl/pull/1583) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/checkout action to v3 [\#1582](https://github.com/jrnl-org/jrnl/pull/1582) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/cache action to v3 [\#1581](https://github.com/jrnl-org/jrnl/pull/1581) ([renovate[bot]](https://github.com/apps/renovate))
- Replace Dependabot with Renovate [\#1575](https://github.com/jrnl-org/jrnl/pull/1575) ([renovate[bot]](https://github.com/apps/renovate))
**Documentation:**
- Add documentation about how the editor must be a blocking process [\#1456](https://github.com/jrnl-org/jrnl/issues/1456)
- Document that editors must be blocking processes [\#1624](https://github.com/jrnl-org/jrnl/pull/1624) ([micahellison](https://github.com/micahellison))
- Remove wrong option in configuration file reference [\#1618](https://github.com/jrnl-org/jrnl/pull/1618) ([DSiekmeier](https://github.com/DSiekmeier))
- Update YAML export description in docs [\#1591](https://github.com/jrnl-org/jrnl/pull/1591) ([apainintheneck](https://github.com/apainintheneck))
- Update dependency jinja2 to v3.1.2 [\#1579](https://github.com/jrnl-org/jrnl/pull/1579) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency typed.js to v2.0.12 [\#1578](https://github.com/jrnl-org/jrnl/pull/1578) ([renovate[bot]](https://github.com/apps/renovate))
- Add hint for how to get vi to go to end-of-file [\#1563](https://github.com/jrnl-org/jrnl/pull/1563) ([pjz](https://github.com/pjz))
**Packaging:**
- Pin dependencies [\#1577](https://github.com/jrnl-org/jrnl/pull/1577) ([renovate[bot]](https://github.com/apps/renovate))
## [v3.2](https://pypi.org/project/jrnl/v3.2/) (2022-09-03)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.2-beta...v3.2)
**Implemented enhancements:**
- Update issue & PR templates to use forms [\#1559](https://github.com/jrnl-org/jrnl/issues/1559)
- Suppress "Entry added" message if using default journal [\#1561](https://github.com/jrnl-org/jrnl/pull/1561) ([micahellison](https://github.com/micahellison))
- Add message showing the number of search results [\#1524](https://github.com/jrnl-org/jrnl/pull/1524) ([apainintheneck](https://github.com/apainintheneck))
**Build:**
- Quick fix follow up for actionlint [\#1565](https://github.com/jrnl-org/jrnl/pull/1565) ([wren](https://github.com/wren))
**Documentation:**
- Remove note in contributing docs about gh-pages branch that we no longer use [\#1566](https://github.com/jrnl-org/jrnl/pull/1566) ([micahellison](https://github.com/micahellison))
## [v3.1](https://pypi.org/project/jrnl/v3.1/) (2022-08-21)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.1-beta2...v3.1)
**Implemented enhancements:**
- Update tzlocal to v4.x and remove pytz dependency [\#1528](https://github.com/jrnl-org/jrnl/pull/1528) ([outa](https://github.com/outa))
- Add linewrap option 'auto' [\#1507](https://github.com/jrnl-org/jrnl/pull/1507) ([jonakeys](https://github.com/jonakeys))
**Fixed bugs:**
- Update formatting function to better account for indentation [\#1541](https://github.com/jrnl-org/jrnl/pull/1541) ([wren](https://github.com/wren))
- Export to file\(s\) when first line/title of an entry is very long [\#1527](https://github.com/jrnl-org/jrnl/pull/1527) ([jonakeys](https://github.com/jonakeys))
- Fixed index out of range error in fancy exporter [\#1522](https://github.com/jrnl-org/jrnl/pull/1522) ([apainintheneck](https://github.com/apainintheneck))
**Build:**
- Add actionlint to testing pipelines [\#1555](https://github.com/jrnl-org/jrnl/pull/1555) ([wren](https://github.com/wren))
- Fix docs pipeline, make docs tests easier to run locally and on different OSes [\#1554](https://github.com/jrnl-org/jrnl/pull/1554) ([wren](https://github.com/wren))
**Documentation:**
- Reformat contributor appreciation on `--help` screen [\#1556](https://github.com/jrnl-org/jrnl/pull/1556) ([xeruf](https://github.com/xeruf))
- Clean up copyright notices and version screen [\#1553](https://github.com/jrnl-org/jrnl/pull/1553) ([wren](https://github.com/wren))
**Packaging:**
- Bump pyproject-flake8 from 0.0.1a4 to 0.0.1a5 [\#1552](https://github.com/jrnl-org/jrnl/pull/1552) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.7.0 to 23.8.2 [\#1551](https://github.com/jrnl-org/jrnl/pull/1551) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump yq from 3.0.2 to 3.1.0 [\#1546](https://github.com/jrnl-org/jrnl/pull/1546) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump poethepoet from 0.15.0 to 0.16.0 [\#1542](https://github.com/jrnl-org/jrnl/pull/1542) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.6.0 to 23.7.0 [\#1539](https://github.com/jrnl-org/jrnl/pull/1539) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump rich from 12.4.4 to 12.5.1 [\#1538](https://github.com/jrnl-org/jrnl/pull/1538) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v3.0](https://pypi.org/project/jrnl/v3.0/) (2022-07-09)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.0-beta2...v3.0)
🚨 **BREAKING CHANGES** 🚨
**Deprecated:**
- Drop support for Python 3.7 and 3.8 [\#1412](https://github.com/jrnl-org/jrnl/pull/1412) ([micahellison](https://github.com/micahellison))
**Implemented enhancements:**
- Show name of journal when creating a password/encrypting [\#1478](https://github.com/jrnl-org/jrnl/pull/1478) ([jonakeys](https://github.com/jonakeys))
- Rework how all output and messaging works in jrnl [\#1475](https://github.com/jrnl-org/jrnl/pull/1475) ([wren](https://github.com/wren))
- Implement --change-time flag [\#1452](https://github.com/jrnl-org/jrnl/pull/1452) ([richardjs](https://github.com/richardjs))
- Reformat additional messages and finish centralizing exception handling [\#1424](https://github.com/jrnl-org/jrnl/pull/1424) ([wren](https://github.com/wren))
- Reformat messages and add new centralized exception handling [\#1417](https://github.com/jrnl-org/jrnl/pull/1417) ([wren](https://github.com/wren))
**Fixed bugs:**
- Display message when no edits take place [\#1510](https://github.com/jrnl-org/jrnl/pull/1510) ([apainintheneck](https://github.com/apainintheneck))
- Fixed error related to display\_format in config file for some values [\#1495](https://github.com/jrnl-org/jrnl/pull/1495) ([apainintheneck](https://github.com/apainintheneck))
- Create folder if config ends with \(back\)slash [\#1492](https://github.com/jrnl-org/jrnl/pull/1492) ([jonakeys](https://github.com/jonakeys))
- `-not` search parameter no longer opens editor [\#1490](https://github.com/jrnl-org/jrnl/pull/1490) ([apainintheneck](https://github.com/apainintheneck))
- Fix TypeError when using debug flag [\#1484](https://github.com/jrnl-org/jrnl/pull/1484) ([jonakeys](https://github.com/jonakeys))
- Prompt for password change when using 'jrnl --encrypt' on already encrypted journal [\#1477](https://github.com/jrnl-org/jrnl/pull/1477) ([jonakeys](https://github.com/jonakeys))
- Always expand all paths \(journals, templates, etc\) [\#1468](https://github.com/jrnl-org/jrnl/pull/1468) ([apainintheneck](https://github.com/apainintheneck))
- The `-not` option with no arguments now outputs error instead of stack trace [\#1466](https://github.com/jrnl-org/jrnl/pull/1466) ([apainintheneck](https://github.com/apainintheneck))
- Give a proper message when trying to use an empty config file [\#1461](https://github.com/jrnl-org/jrnl/pull/1461) ([jonakeys](https://github.com/jonakeys))
- Display "No entry to save, because no text was received" after empty entry on cmdline [\#1459](https://github.com/jrnl-org/jrnl/pull/1459) ([apainintheneck](https://github.com/apainintheneck))
- Yaml export errors now don't show stack trace [\#1449](https://github.com/jrnl-org/jrnl/pull/1449) ([apainintheneck](https://github.com/apainintheneck))
**Build:**
- Pin `pytest-bdd` to \<6.0 to temporarily avoid breaking changes [\#1536](https://github.com/jrnl-org/jrnl/pull/1536) ([wren](https://github.com/wren))
- Reduce difference between local and CI environments [\#1518](https://github.com/jrnl-org/jrnl/pull/1518) ([wren](https://github.com/wren))
- Add bdd tests for jrnl installation [\#1513](https://github.com/jrnl-org/jrnl/pull/1513) ([apainintheneck](https://github.com/apainintheneck))
- Stop hardcoding bot info in changelog pipeline [\#1506](https://github.com/jrnl-org/jrnl/pull/1506) ([wren](https://github.com/wren))
- Fix Poetry caching for accessibility tests [\#1505](https://github.com/jrnl-org/jrnl/pull/1505) ([wren](https://github.com/wren))
- Implement Tox for testing [\#1504](https://github.com/jrnl-org/jrnl/pull/1504) ([wren](https://github.com/wren))
- Replace `make` with python alternative \(`poe`\) [\#1503](https://github.com/jrnl-org/jrnl/pull/1503) ([wren](https://github.com/wren))
- Update copyright year [\#1502](https://github.com/jrnl-org/jrnl/pull/1502) ([wren](https://github.com/wren))
- Add Python 3.11 to PR tests [\#1500](https://github.com/jrnl-org/jrnl/pull/1500) ([micahellison](https://github.com/micahellison))
- Pin jinja2 in docs requirements to keep readthedocs builds from failing [\#1439](https://github.com/jrnl-org/jrnl/pull/1439) ([micahellison](https://github.com/micahellison))
- Tidy up git ignore [\#1414](https://github.com/jrnl-org/jrnl/pull/1414) ([nelnog](https://github.com/nelnog))
**Documentation:**
- Document --change-time in web-based docs' command line reference [\#1471](https://github.com/jrnl-org/jrnl/pull/1471) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Bump cryptography from 37.0.2 to 37.0.3 [\#1516](https://github.com/jrnl-org/jrnl/pull/1516) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump poethepoet from 0.13.1 to 0.14.0 [\#1514](https://github.com/jrnl-org/jrnl/pull/1514) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.5.1 to 23.6.0 [\#1499](https://github.com/jrnl-org/jrnl/pull/1499) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pyxdg from 0.27 to 0.28 [\#1497](https://github.com/jrnl-org/jrnl/pull/1497) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.5.0 to 23.5.1 [\#1487](https://github.com/jrnl-org/jrnl/pull/1487) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump cryptography from 37.0.1 to 37.0.2 [\#1467](https://github.com/jrnl-org/jrnl/pull/1467) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump cryptography from 36.0.2 to 37.0.1 [\#1462](https://github.com/jrnl-org/jrnl/pull/1462) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytest from 7.1.1 to 7.1.2 [\#1458](https://github.com/jrnl-org/jrnl/pull/1458) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pyproject-flake8 from 0.0.1a3 to 0.0.1a4 [\#1447](https://github.com/jrnl-org/jrnl/pull/1447) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump black from 22.1.0 to 22.3.0 [\#1442](https://github.com/jrnl-org/jrnl/pull/1442) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump mkdocs from 1.2.3 to 1.3.0 [\#1441](https://github.com/jrnl-org/jrnl/pull/1441) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pyproject-flake8 from 0.0.1a2 to 0.0.1a3 [\#1440](https://github.com/jrnl-org/jrnl/pull/1440) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytz from 2021.3 to 2022.1 [\#1438](https://github.com/jrnl-org/jrnl/pull/1438) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytest from 7.0.1 to 7.1.1 [\#1430](https://github.com/jrnl-org/jrnl/pull/1430) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump cryptography from 36.0.1 to 36.0.2 [\#1427](https://github.com/jrnl-org/jrnl/pull/1427) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump yq from 2.13.0 to 2.14.0 [\#1418](https://github.com/jrnl-org/jrnl/pull/1418) ([dependabot[bot]](https://github.com/apps/dependabot))
- Replace PyYAML with ruamel.yaml [\#1416](https://github.com/jrnl-org/jrnl/pull/1416) ([micahellison](https://github.com/micahellison))
- Bump pytest from 6.2.5 to 7.0.0 [\#1407](https://github.com/jrnl-org/jrnl/pull/1407) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.8.4](https://pypi.org/project/jrnl/v2.8.4/) (2022-02-12)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.8.4-beta2...v2.8.4)
**Implemented enhancements:**
- Add hash as a default tag symbol for new jrnl config file [\#1398](https://github.com/jrnl-org/jrnl/pull/1398) ([micahellison](https://github.com/micahellison))
- Add --config-file argument to use alternate config file at runtime [\#1290](https://github.com/jrnl-org/jrnl/pull/1290) ([samuelgregorovic](https://github.com/samuelgregorovic))
**Fixed bugs:**
- Certs broken on website [\#1408](https://github.com/jrnl-org/jrnl/issues/1408)
- Add added option to \_print\_edited\_summary [\#1366](https://github.com/jrnl-org/jrnl/pull/1366) ([piero-vic](https://github.com/piero-vic))
**Build:**
- Improve handling of mocking logic in pytest [\#1382](https://github.com/jrnl-org/jrnl/pull/1382) ([wren](https://github.com/wren))
- Use full Python version for GitHub Actions cache key [\#1373](https://github.com/jrnl-org/jrnl/pull/1373) ([micahellison](https://github.com/micahellison))
- Use Python 3.10 stable in CI [\#1362](https://github.com/jrnl-org/jrnl/pull/1362) ([micahellison](https://github.com/micahellison))
- Switch from poetry to poetry-core [\#1359](https://github.com/jrnl-org/jrnl/pull/1359) ([fabaff](https://github.com/fabaff))
- Add more steps to `pytest`, fully remove `behave` [\#1347](https://github.com/jrnl-org/jrnl/pull/1347) ([wren](https://github.com/wren))
**Documentation:**
- Fix styling on documentation sidebar [\#1395](https://github.com/jrnl-org/jrnl/pull/1395) ([wren](https://github.com/wren))
- Added Recipe for visualizing Markdown in the CLI [\#1354](https://github.com/jrnl-org/jrnl/pull/1354) ([viegasfh](https://github.com/viegasfh))
- Fix recipe 'Launch a terminal for rapid logging' [\#1351](https://github.com/jrnl-org/jrnl/pull/1351) ([zapateo](https://github.com/zapateo))
- Fix readme splash and add changelog link to readme [\#1339](https://github.com/jrnl-org/jrnl/pull/1339) ([micahellison](https://github.com/micahellison))
- Add reference documentation to docs site and separate out "Tips and Tricks" and "External Editors" from "Recipes" [\#1332](https://github.com/jrnl-org/jrnl/pull/1332) ([micahellison](https://github.com/micahellison))
- Document journal types [\#1331](https://github.com/jrnl-org/jrnl/pull/1331) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Bump asteval from 0.9.25 to 0.9.26 [\#1400](https://github.com/jrnl-org/jrnl/pull/1400) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump black from 21.7b0 to 22.1.0 [\#1404](https://github.com/jrnl-org/jrnl/pull/1404) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump cryptography from 3.4.8 to 36.0.1 [\#1389](https://github.com/jrnl-org/jrnl/pull/1389) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump ipython from 7.28.0 to 7.31.1 [\#1401](https://github.com/jrnl-org/jrnl/pull/1401) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.1.0 to 23.5.0 [\#1392](https://github.com/jrnl-org/jrnl/pull/1392) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump mkdocs from 1.2.2 to 1.2.3 [\#1355](https://github.com/jrnl-org/jrnl/pull/1355) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytest from 6.2.4 to 6.2.5 [\#1334](https://github.com/jrnl-org/jrnl/pull/1334) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytest-bdd from 4.1.0 to 5.0.0 [\#1368](https://github.com/jrnl-org/jrnl/pull/1368) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytz from 2021.1 to 2021.3 [\#1348](https://github.com/jrnl-org/jrnl/pull/1348) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump yq from 2.12.2 to 2.13.0 [\#1385](https://github.com/jrnl-org/jrnl/pull/1385) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.8.3](https://pypi.org/project/jrnl/v2.8.3/) (2021-09-06)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.8.3-beta...v2.8.3)
**Fixed bugs:**
- Fix deletion of entries on folder journal through `--delete` flag [\#1328](https://github.com/jrnl-org/jrnl/pull/1328) ([micahellison](https://github.com/micahellison))
- Warn when DayOne/directory journals have encrypt: true in config [\#1325](https://github.com/jrnl-org/jrnl/pull/1325) ([micahellison](https://github.com/micahellison))
- Fix failure to import into directory journal [\#1314](https://github.com/jrnl-org/jrnl/pull/1314) ([micahellison](https://github.com/micahellison))
- Allow emoji in config file in Windows by always opening it as unicode [\#1313](https://github.com/jrnl-org/jrnl/pull/1313) ([micahellison](https://github.com/micahellison))
**Build:**
- Set bash as default shell [\#1324](https://github.com/jrnl-org/jrnl/pull/1324) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Bump cryptography from 3.4.7 to 3.4.8 [\#1329](https://github.com/jrnl-org/jrnl/pull/1329) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.0.1 to 23.1.0 [\#1318](https://github.com/jrnl-org/jrnl/pull/1318) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.8.2](https://pypi.org/project/jrnl/v2.8.2/) (2021-07-31)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.8.2-beta...v2.8.2)
**Build:**
- Add CI tests for latest dev Python build [\#1273](https://github.com/jrnl-org/jrnl/issues/1273)
- Fix lock file from stable Poetry version [\#1298](https://github.com/jrnl-org/jrnl/pull/1298) ([wren](https://github.com/wren))
- Change all YAML FullLoader calls to SafeLoader [\#1285](https://github.com/jrnl-org/jrnl/pull/1285) ([micahellison](https://github.com/micahellison))
- Remove useless shebangs and executable permissions [\#1283](https://github.com/jrnl-org/jrnl/pull/1283) ([musicinmybrain](https://github.com/musicinmybrain))
- Add Python 3.10 support [\#1271](https://github.com/jrnl-org/jrnl/pull/1271) ([micahellison](https://github.com/micahellison))
- Ensure that line endings in all py files are Linux style instead of Windows [\#1250](https://github.com/jrnl-org/jrnl/pull/1250) ([micahellison](https://github.com/micahellison))
- Remove `--version` from brew release workflow [\#1233](https://github.com/jrnl-org/jrnl/pull/1233) ([wren](https://github.com/wren))
- Move test suite to Pytest \(replace Behave\) [\#1193](https://github.com/jrnl-org/jrnl/pull/1193) ([wren](https://github.com/wren))
**Documentation:**
- Add documentation about saved passwords in Windows [\#1301](https://github.com/jrnl-org/jrnl/pull/1301) ([micahellison](https://github.com/micahellison))
- Add security.md [\#1299](https://github.com/jrnl-org/jrnl/pull/1299) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Bump mkdocs from 1.2.1 to 1.2.2 [\#1307](https://github.com/jrnl-org/jrnl/pull/1307) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump python-dateutil from 2.8.1 to 2.8.2 [\#1302](https://github.com/jrnl-org/jrnl/pull/1302) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump black from 21.5b1 to 21.5b2 [\#1254](https://github.com/jrnl-org/jrnl/pull/1254) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump black from 21.5b0 to 21.5b1 [\#1244](https://github.com/jrnl-org/jrnl/pull/1244) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump black from 20.8b1 to 21.5b0 [\#1241](https://github.com/jrnl-org/jrnl/pull/1241) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytest from 6.2.3 to 6.2.4 [\#1240](https://github.com/jrnl-org/jrnl/pull/1240) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.8.1](https://pypi.org/project/jrnl/v2.8.1/) (2021-04-24)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.8.1-beta...v2.8.1)
**Fixed bugs:**
- More graceful handling of low linewrap values [\#1219](https://github.com/jrnl-org/jrnl/pull/1219) ([sriniv27](https://github.com/sriniv27))
**Documentation:**
- Update absolute URLs to preview images in metatags [\#1229](https://github.com/jrnl-org/jrnl/pull/1229) ([maebert](https://github.com/maebert))
- Docs: Add emacs as external editor to recipes [\#1220](https://github.com/jrnl-org/jrnl/pull/1220) ([mandarvaze](https://github.com/mandarvaze))
**Packaging:**
- Bump pytest from 6.2.2 to 6.2.3 [\#1228](https://github.com/jrnl-org/jrnl/pull/1228) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump cryptography from 3.4.6 to 3.4.7 [\#1223](https://github.com/jrnl-org/jrnl/pull/1223) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 23.0.0 to 23.0.1 [\#1222](https://github.com/jrnl-org/jrnl/pull/1222) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pyflakes from 2.3.0 to 2.3.1 [\#1221](https://github.com/jrnl-org/jrnl/pull/1221) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.8](https://pypi.org/project/jrnl/v2.8/) (2021-03-27)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.8-beta...v2.8)
**Implemented enhancements:**
- Add `--config-override` feature [\#1169](https://github.com/jrnl-org/jrnl/pull/1169) ([sriniv27](https://github.com/sriniv27))
**Fixed bugs:**
- Fix bug that prevented --format pretty and --format short from working [\#1177](https://github.com/jrnl-org/jrnl/pull/1177) ([sriniv27](https://github.com/sriniv27))
**Build:**
- Fix broken brew release process [\#1211](https://github.com/jrnl-org/jrnl/pull/1211) ([micahellison](https://github.com/micahellison))
**Packaging:**
- Bump pyflakes from 2.2.0 to 2.3.0 [\#1215](https://github.com/jrnl-org/jrnl/pull/1215) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 22.3.0 to 23.0.0 [\#1213](https://github.com/jrnl-org/jrnl/pull/1213) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 22.0.1 to 22.3.0 [\#1210](https://github.com/jrnl-org/jrnl/pull/1210) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump asteval from 0.9.22 to 0.9.23 [\#1209](https://github.com/jrnl-org/jrnl/pull/1209) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.7.1](https://pypi.org/project/jrnl/v2.7.1/) (2021-02-27)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.7...v2.7.1)
**Fixed bugs:**
- Make journal selection behavior more consistent when there's a colon with no date [\#1164](https://github.com/jrnl-org/jrnl/pull/1164) ([wren](https://github.com/wren))
**Documentation:**
- Update documentation about journal-level config values [\#1196](https://github.com/jrnl-org/jrnl/issues/1196)
- update per-journal config documentation [\#1199](https://github.com/jrnl-org/jrnl/pull/1199) ([sriniv27](https://github.com/sriniv27))
**Packaging:**
- Bump cryptography from 3.4.4 to 3.4.6 [\#1195](https://github.com/jrnl-org/jrnl/pull/1195) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump asteval from 0.9.21 to 0.9.22 [\#1189](https://github.com/jrnl-org/jrnl/pull/1189) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump cryptography from 3.3.1 to 3.4.4 [\#1188](https://github.com/jrnl-org/jrnl/pull/1188) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump yq from 2.11.1 to 2.12.0 [\#1186](https://github.com/jrnl-org/jrnl/pull/1186) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytz from 2020.5 to 2021.1 [\#1174](https://github.com/jrnl-org/jrnl/pull/1174) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 21.8.0 to 22.0.1 [\#1168](https://github.com/jrnl-org/jrnl/pull/1168) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytest from 6.2.1 to 6.2.2 [\#1167](https://github.com/jrnl-org/jrnl/pull/1167) ([dependabot[bot]](https://github.com/apps/dependabot))
## [v2.7](https://pypi.org/project/jrnl/v2.7/) (2021-01-23)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.7-beta...v2.7)
**Implemented enhancements:**
- Add new date format \(`--format date`\) for heatmapping [\#1146](https://github.com/jrnl-org/jrnl/pull/1146) ([KarimPwnz](https://github.com/KarimPwnz))
- Add new `-today-in-history`, `-month`, `-day`, and `-year` search filters [\#1145](https://github.com/jrnl-org/jrnl/pull/1145) ([KarimPwnz](https://github.com/KarimPwnz))
- Allow custom extensions when editing \(for easier syntax highlighting\) [\#1139](https://github.com/jrnl-org/jrnl/pull/1139) ([KarimPwnz](https://github.com/KarimPwnz))
**Fixed bugs:**
- Editor can't be launched on Windows when using full path to editor executable [\#1096](https://github.com/jrnl-org/jrnl/issues/1096)
- Fix OS compatibility issues for editors with spaces, slashes, and quotes [\#1153](https://github.com/jrnl-org/jrnl/pull/1153) ([micahellison](https://github.com/micahellison))
- Add delimiters in YAML format [\#1150](https://github.com/jrnl-org/jrnl/pull/1150) ([Seopril](https://github.com/Seopril))
- Fix keyring error handling [\#1138](https://github.com/jrnl-org/jrnl/pull/1138) ([KarimPwnz](https://github.com/KarimPwnz))
- Notify user when config directory can't be created because there is already a file with the same name [\#1134](https://github.com/jrnl-org/jrnl/pull/1134) ([micahellison](https://github.com/micahellison))
**Build:**
- Fix homebrew release, add options for release pipeline [\#1154](https://github.com/jrnl-org/jrnl/pull/1154) ([wren](https://github.com/wren))
- Fix changelog generator [\#1127](https://github.com/jrnl-org/jrnl/pull/1127) ([wren](https://github.com/wren))
**Documentation:**
- add instructions to add VSCode as an external editor for Windows [\#1155](https://github.com/jrnl-org/jrnl/issues/1155)
- Clarify editor documentation for PATH variable and VS Code [\#1160](https://github.com/jrnl-org/jrnl/pull/1160) ([micahellison](https://github.com/micahellison))
- Emphasize installing dependencies before testing [\#1148](https://github.com/jrnl-org/jrnl/pull/1148) ([gumatias](https://github.com/gumatias))
- Clarify installation documentation \(\#1097\) [\#1137](https://github.com/jrnl-org/jrnl/pull/1137) ([Seopril](https://github.com/Seopril))
- Fix broken search bar in docs site [\#1135](https://github.com/jrnl-org/jrnl/pull/1135) ([wren](https://github.com/wren))
- Fix search on docs site [\#1133](https://github.com/jrnl-org/jrnl/pull/1133) ([wren](https://github.com/wren))
- Add packaging label to changelog generator config [\#1132](https://github.com/jrnl-org/jrnl/pull/1132) ([wren](https://github.com/wren))
- Fix failing contrast test in accessibility tools on docs site [\#1126](https://github.com/jrnl-org/jrnl/pull/1126) ([wren](https://github.com/wren))
**Packaging:**
- Bump pyyaml from 5.3.1 to 5.4.1 [\#1158](https://github.com/jrnl-org/jrnl/pull/1158) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump keyring from 21.7.0 to 21.8.0 [\#1136](https://github.com/jrnl-org/jrnl/pull/1136) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump pytz from 2020.4 to 2020.5 [\#1130](https://github.com/jrnl-org/jrnl/pull/1130) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
- Bump pytest from 6.2.0 to 6.2.1 [\#1129](https://github.com/jrnl-org/jrnl/pull/1129) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
- Bump keyring from 21.5.0 to 21.7.0 [\#1128](https://github.com/jrnl-org/jrnl/pull/1128) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
## [v2.6](https://pypi.org/project/jrnl/v2.6/) (2020-12-20)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.5...v2.6)
**Implemented enhancements:**
- Add ability to put --edit partly through a cli entry to move it to the editor [\#1091](https://github.com/jrnl-org/jrnl/pull/1091) ([wren](https://github.com/wren))
- Allow --edit flag partway through an entry [\#906](https://github.com/jrnl-org/jrnl/issues/906)
**Fixed bugs:**
- Check for readline module instead of Windows when initializing autocomplete in install [\#1104](https://github.com/jrnl-org/jrnl/pull/1104) ([micahellison](https://github.com/micahellison))
- Directory export crashes in Windows with certain characters - UnicodeEncodeError: 'locale' codec can't encode character [\#1089](https://github.com/jrnl-org/jrnl/issues/1089)
- Fix Unicode encoding failure in directory export when creating filenames from journal titles with certain characters [\#1090](https://github.com/jrnl-org/jrnl/pull/1090) ([micahellison](https://github.com/micahellison))
- Typo fix in output.py: "us" -\> "use" [\#1117](https://github.com/jrnl-org/jrnl/pull/1117) ([signal-9](https://github.com/signal-9))
**Build:**
- Add a release workflow for PyPI in CI \(Github Actions\) [\#1095](https://github.com/jrnl-org/jrnl/pull/1095) ([wren](https://github.com/wren))
- Add automatic deployment for homebrew releases \(and prereleases\) [\#1111](https://github.com/jrnl-org/jrnl/pull/1111) ([wren](https://github.com/wren))
- Add changelog generation workflow to github actions [\#1086](https://github.com/jrnl-org/jrnl/pull/1086) ([wren](https://github.com/wren))
- Add fix for changelog conditional always returning false [\#1101](https://github.com/jrnl-org/jrnl/pull/1101) ([wren](https://github.com/wren))
- Change approach for docs workflow to use pa11y-ci [\#1116](https://github.com/jrnl-org/jrnl/pull/1116) ([wren](https://github.com/wren))
- Changelog fixes [\#1088](https://github.com/jrnl-org/jrnl/pull/1088) ([wren](https://github.com/wren))
- Fix trigger for changelog [\#1114](https://github.com/jrnl-org/jrnl/pull/1114) ([wren](https://github.com/wren))
- Make changelog auto exclude stale and wontfix issues [\#1081](https://github.com/jrnl-org/jrnl/pull/1081) ([wren](https://github.com/wren))
- Migrate to Github Actions from Travis CI [\#1060](https://github.com/jrnl-org/jrnl/issues/1060)
- More changelog fixes [\#1092](https://github.com/jrnl-org/jrnl/pull/1092) ([wren](https://github.com/wren))
- Standardize version regex in release pipeline [\#1124](https://github.com/jrnl-org/jrnl/pull/1124) ([wren](https://github.com/wren))
- Udpate build badge in readme to point at github instead of travis [\#1094](https://github.com/jrnl-org/jrnl/pull/1094) ([wren](https://github.com/wren))
- Update all dependencies and lock file [\#1110](https://github.com/jrnl-org/jrnl/pull/1110) ([wren](https://github.com/wren))
- get rid of travis and circle configs \(in favor of github actions\) [\#1082](https://github.com/jrnl-org/jrnl/pull/1082) ([wren](https://github.com/wren))
**Documentation:**
- Add visual header to readme [\#1085](https://github.com/jrnl-org/jrnl/pull/1085) ([wren](https://github.com/wren))
- Comply with GPL by acknowledging all authors and including license info in each source file [\#1121](https://github.com/jrnl-org/jrnl/pull/1121) ([micahellison](https://github.com/micahellison))
- Fix lone closing parenthesis [\#1118](https://github.com/jrnl-org/jrnl/pull/1118) ([maebert](https://github.com/maebert))
- Make docs site \(jrnl.sh\) fully meet Web Content Accessibility Guidelines \(WCAG\) 2.1 [\#1105](https://github.com/jrnl-org/jrnl/pull/1105) ([wren](https://github.com/wren))
- Small accessibility fixes for docs site [\#1122](https://github.com/jrnl-org/jrnl/pull/1122) ([wren](https://github.com/wren))
## [v2.5](https://pypi.org/project/jrnl/v2.5/) (2020-11-07)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.5...v2.5)
**Implemented enhancements:**
- 🚨 Deprecate Python 3.6 🚨 [\#992](https://github.com/jrnl-org/jrnl/issues/992)
- Add support for Python 3.9 [\#1017](https://github.com/jrnl-org/jrnl/issues/1017)
- Implement arg parsing library [\#866](https://github.com/jrnl-org/jrnl/issues/866)
- Rename `--export` to `--format` and `--export -o` to `--format --file` [\#814](https://github.com/jrnl-org/jrnl/issues/814)
- Pull functionality out of util.py [\#737](https://github.com/jrnl-org/jrnl/issues/737)
- Support -not for individual @tag in the command line [\#374](https://github.com/jrnl-org/jrnl/issues/374)
- Add punctuation more commonly used in Asian languages \(ellipsis\) to sentence parsing [\#1044](https://github.com/jrnl-org/jrnl/pull/1044) ([felixonmars](https://github.com/felixonmars))
- Clean up help screen, get rid of util.py [\#1027](https://github.com/jrnl-org/jrnl/pull/1027) ([wren](https://github.com/wren))
**Fixed bugs:**
- Extra error when writing empty entry [\#1048](https://github.com/jrnl-org/jrnl/issues/1048)
- 'Edit on Github' Button in Documentation not working [\#1039](https://github.com/jrnl-org/jrnl/issues/1039)
- Decrypt jrnl file in dropbox on another machine fails [\#1019](https://github.com/jrnl-org/jrnl/issues/1019)
- Listing jrnl entries by tag for non default journal seem to not work as expected. [\#875](https://github.com/jrnl-org/jrnl/issues/875)
- -and parameter seems to only work for the default journal [\#520](https://github.com/jrnl-org/jrnl/issues/520)
- Disable logging by default [\#1053](https://github.com/jrnl-org/jrnl/pull/1053) ([wren](https://github.com/wren))
- Partial refactor of cli.py \(mainly help screen and arg parsing\) [\#991](https://github.com/jrnl-org/jrnl/pull/991) ([wren](https://github.com/wren))
**Build:**
- Add accessibility testing for docs site \(https://jrnl.sh) [\#1067](https://github.com/jrnl-org/jrnl/pull/1067) ([wren](https://github.com/wren))
- Add circle ci config file for linux tests [\#1063](https://github.com/jrnl-org/jrnl/pull/1063) ([wren](https://github.com/wren))
- Lots of test refactoring [\#1042](https://github.com/jrnl-org/jrnl/pull/1042) ([wren](https://github.com/wren))
- Add support for Python 3.9 build testing [\#1018](https://github.com/jrnl-org/jrnl/pull/1018) ([micahellison](https://github.com/micahellison))
- Resolve Travis/Windows/pip issues with upgrade to cryptography 3.0 [\#1016](https://github.com/jrnl-org/jrnl/pull/1016) ([micahellison](https://github.com/micahellison))
**Updated documentation:**
- Clarify usage output between export and reading sections [\#344](https://github.com/jrnl-org/jrnl/issues/344)
- Fix "Edit on GitHub" button on docs site [\#1043](https://github.com/jrnl-org/jrnl/pull/1043) ([matildepark](https://github.com/matildepark))
- Correct typos in CONTRIBUTING.md [\#1040](https://github.com/jrnl-org/jrnl/pull/1040) ([felixonmars](https://github.com/felixonmars))
- Change styling of terminal on docs site, small copy changes [\#1038](https://github.com/jrnl-org/jrnl/pull/1038) ([wren](https://github.com/wren))
- Documentation updates [\#1032](https://github.com/jrnl-org/jrnl/pull/1032) ([micahellison](https://github.com/micahellison))
- Updated advanced.md in docs to reflect all four subkeys under colors … [\#1023](https://github.com/jrnl-org/jrnl/pull/1023) ([DacodaNelson](https://github.com/DacodaNelson))
- Update github issue templates to use new diagnostic command [\#1022](https://github.com/jrnl-org/jrnl/pull/1022) ([wren](https://github.com/wren))
## [v2.4.5](https://pypi.org/project/jrnl/v2.4.5/) (2020-07-31)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.4...v2.4.5)
**Fixed bugs:**
- Add missing dependency \(packaging\) [\#1011](https://github.com/jrnl-org/jrnl/pull/1011) ([wren](https://github.com/wren))
## [v2.4.4](https://pypi.org/project/jrnl/v2.4.4/) (2020-07-25)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.4...v2.4.3)
**Implemented enhancements:**
- Add --diagnostic argument [\#984](https://github.com/jrnl-org/jrnl/pull/984) ([micahellison](https://github.com/micahellison))
- Add tags to json and xml exporters [\#975](https://github.com/jrnl-org/jrnl/pull/975) ([eshrh](https://github.com/eshrh))
- Add extended metadata support for DayOne Classic [\#928](https://github.com/jrnl-org/jrnl/pull/928) ([MinchinWeb](https://github.com/MinchinWeb))
**Fixed bugs:**
- Allow editing of DayOne entries [\#1001](https://github.com/jrnl-org/jrnl/pull/1001) ([minchinweb](https://github.com/minchinweb), [micahellison](https://github.com/micahellison), [wren](https://github.com/wren))
- Create journal with absolute path when no path is specified [\#972](https://github.com/jrnl-org/jrnl/pull/972) ([eshrh](https://github.com/eshrh))
**Build:**
- Add unit testing via pytest [\#987](https://github.com/jrnl-org/jrnl/pull/987) ([micahellison](https://github.com/micahellison))
- Rename master branch to release [\#985](https://github.com/jrnl-org/jrnl/pull/985) ([wren](https://github.com/wren))
**Updated documentation:**
- Fix readme link to submit an issue [\#1002](https://github.com/jrnl-org/jrnl/pull/1002) ([wren](https://github.com/wren))
- Extensive modifications to overview.md [\#957](https://github.com/jrnl-org/jrnl/pull/957) ([guydebros](https://github.com/guydebros))
## [v2.4.3](https://pypi.org/project/jrnl/v2.4.3/) (2020-06-13)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.2...v2.4.3)
**Implemented enhancements:**
- Speed up jrnl by 10%, improve slow imports [\#959](https://github.com/jrnl-org/jrnl/pull/959) ([wotgl](https://github.com/wotgl))
**Fixed bugs:**
- Fix set\_keychain errors [\#964](https://github.com/jrnl-org/jrnl/pull/964) ([eshrh](https://github.com/eshrh))
- Fix title splitting logic to account for both newlines and periods [\#958](https://github.com/jrnl-org/jrnl/pull/958) ([eshrh](https://github.com/eshrh))
- Fix editor config when an argument with a space is used [\#953](https://github.com/jrnl-org/jrnl/pull/953) ([wren](https://github.com/wren))
- Ask for password before adding entry instead of after [\#951](https://github.com/jrnl-org/jrnl/pull/951) ([ollybritton](https://github.com/ollybritton))
- Fix duplicate text in multiple tag search [\#948](https://github.com/jrnl-org/jrnl/pull/948) ([micahellison](https://github.com/micahellison))
**Build:**
- Fix for hanging Windows tests on Travis [\#969](https://github.com/jrnl-org/jrnl/pull/969) ([wren](https://github.com/wren))
- Ensure test data is always checked out with LF line endings [\#965](https://github.com/jrnl-org/jrnl/pull/965) ([micahellison](https://github.com/micahellison))
- Clean up templates and issues [\#954](https://github.com/jrnl-org/jrnl/pull/954) ([wren](https://github.com/wren))
- Update lockbot comment to encourage linking to issue [\#941](https://github.com/jrnl-org/jrnl/pull/941) ([MinchinWeb](https://github.com/MinchinWeb))
**Updated documentation:**
- Cleaned up usage.md for clarity, formatting, and grammar. [\#956](https://github.com/jrnl-org/jrnl/pull/956) ([guydebros](https://github.com/guydebros))
## [v2.4.2](https://pypi.org/project/jrnl/v2.4.2/) (2020-05-09)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.1...v2.4.2)
**Fixed bugs:**
- Prevent filtered delete from deleting journal [\#935](https://github.com/jrnl-org/jrnl/pull/935) ([micahellison](https://github.com/micahellison))
**Build:**
- Make sure testing cleans up after itself [\#940](https://github.com/jrnl-org/jrnl/pull/940) ([wren](https://github.com/wren))
- Allow most recent pytz version and update dependencies [\#937](https://github.com/jrnl-org/jrnl/pull/937) ([micahellison](https://github.com/micahellison))
- Use gitlab to trigger releases in pipeline [\#947](https://github.com/jrnl-org/jrnl/pull/947) ([wren](https://github.com/wren))
**Updated documentation:**
- Change jrnl.sh GitHub new issue link to issue template chooser [\#936](https://github.com/jrnl-org/jrnl/pull/936) ([micahellison](https://github.com/micahellison))
- Improve privacy, security, and encryption documentation \#896 [\#925](https://github.com/jrnl-org/jrnl/pull/925) ([micahellison](https://github.com/micahellison))
## [v2.4.1](https://pypi.org/project/jrnl/v2.4.1/) (2020-05-02)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4...v2.4.1)
**Fixed bugs:**
- Disable --delete due to critical bug [\#934](https://github.com/jrnl-org/jrnl/pull/934) ([wren](https://github.com/wren))
## [v2.4](https://pypi.org/project/jrnl/v2.4/) (2020-04-25)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.3.1...v2.4)
**Implemented enhancements:**
- Update keyring version from "^19.0" to "\>19.0, \<22.0" [\#914](https://github.com/jrnl-org/jrnl/pull/914) ([micahellison](https://github.com/micahellison))
- Allow tzlocal version \>1.5 \<3.0 instead of \>1.5 \<2.0 [\#900](https://github.com/jrnl-org/jrnl/pull/900) ([micahellison](https://github.com/micahellison))
- Interactive delete [\#650](https://github.com/jrnl-org/jrnl/pull/850) ([alichtman](https://github.com/alichtman))
- Upgrade license to GPLv3 [\#918](https://github.com/jrnl-org/jrnl/pull/918) ([wren](https://github.com/wren), [micahellison](https://github.com/micahellison))
**Fixed bugs:**
- Fix Python 3.9 incompatibility by updating plistlib [\#909](https://github.com/jrnl-org/jrnl/pull/909) ([MinchinWeb](https://github.com/MinchinWeb))
- Ensure exported entries end in a newline for Markdown and YAML exporters [\#908](https://github.com/jrnl-org/jrnl/pull/908) ([MinchinWeb](https://github.com/MinchinWeb))
- Fix typo in YAML exporter \("stared" -\> "starred"\) [\#907](https://github.com/jrnl-org/jrnl/pull/907) ([MinchinWeb](https://github.com/MinchinWeb))
- Fix for upgrade with missing journal [\#796](https://github.com/jrnl-org/jrnl/pull/796) ([dbxnr](https://github.com/dbxnr))
**Build:**
- Update Python versions in pipeline [\#910](https://github.com/jrnl-org/jrnl/pull/910) ([MinchinWeb](https://github.com/MinchinWeb))
- Update Poetry requirements for testing latest Python version [\#898](https://github.com/jrnl-org/jrnl/pull/898) ([wren](https://github.com/wren))
- Update makefile to match pipeline better [\#919](https://github.com/jrnl-org/jrnl/pull/919) ([wren](https://github.com/wren))
**Updated documentation:**
- Update the code of conduct [\#913](https://github.com/jrnl-org/jrnl/pull/913) ([wren](https://github.com/wren))
- Update twitter buttons, contribution in footer [\#905](https://github.com/jrnl-org/jrnl/pull/905) ([wren](https://github.com/wren))
- Change install doc guideline from pip to pipx [\#904](https://github.com/jrnl-org/jrnl/pull/904) ([micahellison](https://github.com/micahellison))
- Update twitter buttons, contribution in footer [\#905](https://github.com/jrnl-org/jrnl/pull/905) ([wren](https://github.com/wren))
- Clean up readme file [\#924](https://github.com/jrnl-org/jrnl/pull/924) ([wren](https://github.com/wren))
- Clarify that editing config isn't always destructive [\#923](https://github.com/jrnl-org/jrnl/pull/923) ([Epskampie](https://github.com/Epskampie))
## [v2.3](https://pypi.org/project/jrnl/v2.3/) (2020-03-21)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.2...v2.3)
**Implemented enhancements:**
- Update YAML exporter to handle Dayone format [\#773](https://github.com/jrnl-org/jrnl/pull/773) ([MinchinWeb](https://github.com/MinchinWeb))
- Pretty print journal entries (add color) [\#692](https://github.com/jrnl-org/jrnl/pull/692) ([alichtman](https://github.com/alichtman))
- Allow journals to be saved into multiple files in a directory structure [\#485](https://github.com/jrnl-org/jrnl/pull/485) ([notbalanced](https://github.com/notbalanced))
**Fixed bugs:**
- Listing all entries in DayOne Classic journal throws IndexError [\#786](https://github.com/jrnl-org/jrnl/pull/786) ([MinchinWeb](https://github.com/MinchinWeb))
- Add UTC support for failing DayOne tests [\#785](https://github.com/jrnl-org/jrnl/pull/785) ([MinchinWeb](https://github.com/MinchinWeb))
**Build:**
- Stop multiple changelog generators from crashing into each other [\#845](https://github.com/jrnl-org/jrnl/pull/845) ([wren](https://github.com/wren))
- Don't re-run tests on deployment [\#839](https://github.com/jrnl-org/jrnl/pull/839) ([wren](https://github.com/wren))
- Put back build lines in Poetry config [\#838](https://github.com/jrnl-org/jrnl/pull/838) ([wren](https://github.com/wren))
- Restore emoji test [\#837](https://github.com/jrnl-org/jrnl/pull/837) ([micahellison](https://github.com/micahellison))
- Fix crashing unicode Travis tests on Windows and fail build if Windows tests fail [\#836](https://github.com/jrnl-org/jrnl/pull/836) ([micahellison](https://github.com/micahellison))
- Remove poetry from build system in pyproject config to fix `brew install` [\#830](https://github.com/jrnl-org/jrnl/pull/830) ([wren](https://github.com/wren))
- Fix all skipped tests on Travis Windows builds by preserving newlines [\#823](https://github.com/jrnl-org/jrnl/pull/823) ([micahellison](https://github.com/micahellison))
**Updated documentation:**
- Update url for "beautiful timeline" in export.md [\#879](https://github.com/jrnl-org/jrnl/pull/879) ([NGenetzky](https://github.com/NGenetzky))
- Docs: Fix broken links in recipes.md [\#854](https://github.com/jrnl-org/jrnl/pull/854) ([lrvl](https://github.com/lrvl))
- Fix configuration slashes and indentation in advanced usage documentation [\#852](https://github.com/jrnl-org/jrnl/pull/852) ([aallbrig](https://github.com/aallbrig))
- Fix fish history instructions. [\#846](https://github.com/jrnl-org/jrnl/pull/846) ([aureooms](https://github.com/aureooms))
- Update site description [\#841](https://github.com/jrnl-org/jrnl/pull/841) ([wren](https://github.com/wren))
- Get rid of dumb sex joke [\#840](https://github.com/jrnl-org/jrnl/pull/840) ([wren](https://github.com/wren))
- Updating/clarifying template explanation [\#829](https://github.com/jrnl-org/jrnl/pull/829) ([heymajor](https://github.com/heymajor))
## [v2.2](https://pypi.org/project/jrnl/v2.2/) (2020-02-01)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.1.1...v2.2)
**Implemented enhancements:**
- Full text search \(case insensitive\) with "-contains" [\#740](https://github.com/jrnl-org/jrnl/pull/740) ([empireshades](https://github.com/empireshades))
- Reduce startup time by 55% [\#719](https://github.com/jrnl-org/jrnl/pull/719) ([maebert](https://github.com/maebert))
- Refactor password logic to prevent accidental password leakage [\#708](https://github.com/jrnl-org/jrnl/pull/708) ([pspeter](https://github.com/pspeter))
- Password confirmation [\#706](https://github.com/jrnl-org/jrnl/pull/706) ([pspeter](https://github.com/pspeter))
**Fixed bugs:**
- Close temp file before passing it to editor to prevent file locking issues in Windows [\#792](https://github.com/jrnl-org/jrnl/pull/792) ([micahellison](https://github.com/micahellison))
- Fix crash while encrypting a journal on first run without saving password [\#789](https://github.com/jrnl-org/jrnl/pull/789) ([dbxnr](https://github.com/dbxnr))
**Build:**
- Fix issue where jrnl would always out 'source' for version, fix Poetry config to build and publish properly [\#820](https://github.com/jrnl-org/jrnl/pull/820) ([wren](https://github.com/wren))
- Unpin poetry [\#808](https://github.com/jrnl-org/jrnl/pull/808) ([wren](https://github.com/wren))
- Fix all skipped tests on Travis Windows builds by preserving newlines [\#823](https://github.com/jrnl-org/jrnl/pull/823) ([micahellison](https://github.com/micahellison))
- Change PyPI auth method in build pipeline [\#807](https://github.com/jrnl-org/jrnl/pull/807) ([wren](https://github.com/wren))
- Automagically update the changelog you see before your very eyes! [\#806](https://github.com/jrnl-org/jrnl/pull/806) ([wren](https://github.com/wren))
- Update Black version and lock file to fix builds on develop branch [\#784](https://github.com/jrnl-org/jrnl/pull/784) ([wren](https://github.com/wren))
- Run black formatter on codebase for standardization [\#778](https://github.com/jrnl-org/jrnl/pull/778) ([wren](https://github.com/wren))
- Skip Broken Windows Tests [\#772](https://github.com/jrnl-org/jrnl/pull/772) ([wren](https://github.com/wren))
- Black Formatter [\#769](https://github.com/jrnl-org/jrnl/pull/769) ([MinchinWeb](https://github.com/MinchinWeb))
- Update lock file and testing suite for Python 3.8 [\#765](https://github.com/jrnl-org/jrnl/pull/765) ([wren](https://github.com/wren))
- Fix CI config to only deploy once [\#761](https://github.com/jrnl-org/jrnl/pull/761) ([wren](https://github.com/wren))
- More Travis-CI Testing [\#759](https://github.com/jrnl-org/jrnl/pull/759) ([MinchinWeb](https://github.com/MinchinWeb))
**Updated documentation:**
- Explain how fish can be configured to exclude jrnl commands from history by default [\#809](https://github.com/jrnl-org/jrnl/pull/809) ([aureooms](https://github.com/aureooms))
- Remove merge marker in recipes.md [\#782](https://github.com/jrnl-org/jrnl/pull/782) ([markphelps](https://github.com/markphelps))
- Fix merge conflict left-over [\#767](https://github.com/jrnl-org/jrnl/pull/767) ([thejspr](https://github.com/thejspr))
- Display header in docs on mobile devices [\#763](https://github.com/jrnl-org/jrnl/pull/763) ([maebert](https://github.com/maebert))
## [v2.1.1](https://pypi.org/project/jrnl/v2.1.1/) (2019-11-26)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.1.post2...v2.1.1)
**Implemented enhancements:**
- Support Python 3.6+ [\#710](https://github.com/jrnl-org/jrnl/pull/710) ([pspeter](https://github.com/pspeter))
- Drop Python 2 support, add mocks in tests [\#705](https://github.com/jrnl-org/jrnl/pull/705) ([pspeter](https://github.com/pspeter))
**Fixed bugs:**
- Prevent readline usage on Windows, which was causing Active Python crashes on install [\#751](https://github.com/jrnl-org/jrnl/pull/751) ([micahellison](https://github.com/micahellison))
- Exit jrnl if no text entered into editor [\#744](https://github.com/jrnl-org/jrnl/pull/744) ([alichtman](https://github.com/alichtman))
- Fix crash when no keyring backend available [\#699](https://github.com/jrnl-org/jrnl/pull/699) ([pspeter](https://github.com/pspeter))
- Fix parsing Journals using a little-endian date format [\#694](https://github.com/jrnl-org/jrnl/pull/694) ([pspeter](https://github.com/pspeter))
**Updated documentation:**
- Update developer documentation [\#752](https://github.com/jrnl-org/jrnl/pull/752) ([micahellison](https://github.com/micahellison))
- Create templates for issues and pull requests [\#679](https://github.com/jrnl-org/jrnl/pull/679) ([C0DK](https://github.com/C0DK))
- Smaller doc fixes [\#649](https://github.com/jrnl-org/jrnl/pull/649) ([maebert](https://github.com/maebert))
- Move to mkdocs [\#611](https://github.com/jrnl-org/jrnl/pull/611) ([maebert](https://github.com/maebert))
## [v2.1.post2](https://pypi.org/project/jrnl/v2.1.post2/) (2019-11-11)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.0.1...v2.1.post2)
**Fixed bugs:**
- Expand paths that use ~ to full path [\#704](https://github.com/jrnl-org/jrnl/pull/704) ([MinchinWeb](https://github.com/MinchinWeb))
**Build:**
- Separate local dev from pipeline releases [\#684](https://github.com/jrnl-org/jrnl/pull/684) ([wren](https://github.com/wren))
- Update version handling in source and travis deployments [\#683](https://github.com/jrnl-org/jrnl/pull/683) ([wren](https://github.com/wren))
- Use Poetry for dependency management and deployments [\#612](https://github.com/jrnl-org/jrnl/pull/612) ([maebert](https://github.com/maebert))
**Updated documentation:**
- Fix typos, spelling [\#734](https://github.com/jrnl-org/jrnl/pull/734) ([MinchinWeb](https://github.com/MinchinWeb))
## [v2.0.1](https://pypi.org/project/jrnl/v2.0.1/) (2019-09-26)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.0.0...v2.0.1)
**Implemented enhancements:**
- Switch to hashmark Markdown headers on export \(Mk II\) [\#639](https://github.com/jrnl-org/jrnl/pull/639) ([MinchinWeb](https://github.com/MinchinWeb))
- Add '-not' flag for excluding tags from filter [\#637](https://github.com/jrnl-org/jrnl/pull/637) ([jprof](https://github.com/jprof))
- Handle KeyboardInterrupt when installing journal [\#550](https://github.com/jrnl-org/jrnl/pull/550) ([silenc3r](https://github.com/silenc3r))
**Fixed bugs:**
- Change pyYAML required version [\#660](https://github.com/jrnl-org/jrnl/pull/660) ([etnnth](https://github.com/etnnth))
**Updated documentation:**
- Fix references to Sphinx in CONTRIBUTING.md [\#655](https://github.com/jrnl-org/jrnl/pull/655) ([maebert](https://github.com/maebert))
## [v2.0.0](https://pypi.org/project/jrnl/v2.0.0/) (2019-08-24)
[Full Changelog](https://github.com/jrnl-org/jrnl/compare/1.9.8...v2.0.0)
🚨 **BREAKING CHANGES** 🚨
**Implemented enhancements:**
- Change cryptographic backend from PyCrypto to cryptography.io
- Config now respects XDG conventions and may move accordingly
- Config name changed from `journals.jrnl_name.journal` to `journals.jrnl_name.path`
**Fixed bugs:**
- Confirm that each journal can be parsed during upgrade, and abort upgrade if not [\#650](https://github.com/jrnl-org/jrnl/pull/650) ([micahellison](https://github.com/micahellison))
- Escape dates in square brackets [\#644](https://github.com/jrnl-org/jrnl/pull/644) ([wren](https://github.com/wren))
- Create encrypted journal [\#641](https://github.com/jrnl-org/jrnl/pull/641) ([gregorybodnar](https://github.com/gregorybodnar))
- Resolve issues around unreadable dates to allow markdown footnotes and prevent accidental deletion [\#623](https://github.com/jrnl-org/jrnl/pull/623) ([micahellison](https://github.com/micahellison))
- Update crypto module \#610 [\#621](https://github.com/jrnl-org/jrnl/pull/621) ([wren](https://github.com/wren))
- Fix issue \#584 YAMLLoadWarning [\#585](https://github.com/jrnl-org/jrnl/pull/585) ([wren](https://github.com/wren))
**Deprecated:**
- Deprecate Python 2 [\#624](https://github.com/jrnl-org/jrnl/pull/624) ([micahellison](https://github.com/micahellison))
- Config now saved as YAML (no more JSON)
**Build:**
- change pinned label to a super cool emoji ⭐️ [\#646](https://github.com/jrnl-org/jrnl/pull/646) ([wren](https://github.com/wren))
- Update Travis build badge and restore pypi badges [\#603](https://github.com/jrnl-org/jrnl/pull/603) ([micahellison](https://github.com/micahellison))
**Updated documentation:**
- Mention lack of Day One support and relevant history in readme [\#608](https://github.com/jrnl-org/jrnl/pull/608) ([micahellison](https://github.com/micahellison))
- Add a code of conduct file \(rather than adding to contributing\) [\#604](https://github.com/jrnl-org/jrnl/pull/604) ([wren](https://github.com/wren))
- Update docs to reflect merging jrnl-plus fork back upstream [\#601](https://github.com/jrnl-org/jrnl/pull/601) ([micahellison](https://github.com/micahellison))
- Add instructions for VS Code [\#544](https://github.com/jrnl-org/jrnl/pull/544) ([emceeaich](https://github.com/emceeaich))
## v1.9 (2014-07-21)
* __1.9.5__ Multi-word tags for DayOne Journals
* __1.9.4__ Fixed: Order of journal entries in file correct after --edit'ing
* __1.9.3__ Fixed: Tags at the beginning of lines
* __1.9.2__ Fixed: Tag search ignores email-addresses (thanks to @mjhoffman65)
* __1.9.1__ Fixed: Dates in the future can be parsed as well.
* __1.9.0__ Improved: Greatly improved date parsing. Also added an `-on` option for filtering
## v1.8 (2014-05-22)
* __1.8.7__ Fixed: -from and -to filters are inclusive (thanks to @grplyler)
* __1.8.6__ Improved: Tags like @C++ and @OS/2 work, too (thanks to @chaitan94)
* __1.8.5__ Fixed: file names when exporting to individual files contain full year (thanks to @jdevera)
* __1.8.4__ Improved: using external editors (thanks to @chrissexton)
* __1.8.3__ Fixed: export to text files and improves help (thanks to @igniteflow and @mpe)
* __1.8.2__ Better integration with environment variables (thanks to @ajaam and @matze)
* __1.8.1__ Minor bug fixes
* __1.8.0__ Official support for python 3.4
## v1.7 (2013-12-22)
* __1.7.22__ Fixed an issue with writing files when exporting entries containing non-ascii characters.
* __1.7.21__ jrnl now uses PKCS#7 padding.
* __1.7.20__ Minor fixes when parsing DayOne journals
* __1.7.19__ Creates full path to journal during installation if it doesn't exist yet
* __1.7.18__ Small update to parsing regex
* __1.7.17__ Fixes writing new lines between entries
* __1.7.16__ Even more unicode fixes!
* __1.7.15__ More unicode fixes
* __1.7.14__ Fix for trailing whitespaces (eg. when writing markdown code block)
* __1.7.13__ Fix for UTF-8 in DayOne journals
* __1.7.12__ Fixes a bug where filtering by tags didn't work for DayOne journals
* __1.7.11__ `-ls` will list all available journals (Thanks @jtan189)
* __1.7.10__ Supports `-3` as a shortcut for `-n 3` and updates to tzlocal 1.1
* __1.7.9__ Fix a logic bug so that jrnl -h and jrnl -v are possible even if jrnl not configured yet.
* __1.7.8__ Upgrade to parsedatetime 1.2
* __1.7.7__ Cleaned up imports, better unicode support
* __1.7.6__ Python 3 port for slugify
* __1.7.5__ Colorama is only needed on Windows. Smaller fixes
* __1.7.3__ Touches temporary files before opening them to allow more external editors.
* __1.7.2__ Dateutil added to requirements.
* __1.7.1__ Fixes issues with parsing time information in entries.
* __1.7.0__ Edit encrypted or DayOne journals with `jrnl --edit`.
## v1.6 (2013-11-05)
* __1.6.6__ -v prints the current version, also better strings for windows users. Furthermore, jrnl/jrnl.py moved to jrnl/cli.py
* __1.6.5__ Allows composing multi-line entries on the command line or importing files
* __1.6.4__ Fixed a bug that caused creating encrypted journals to fail
* __1.6.3__ New, pretty, _useful_ documentation!
* __1.6.2__ Starring entries now works for plain-text journals too!
* __1.6.1__ Attempts to fix broken config files automatically
* __1.6.0__ Passwords are now saved in the key-chain. The `password` field in `.jrnl_config` is soft-deprecated.
## v1.5 (2013-08-06)
* __1.5.7__ The `~` in journal config paths will now expand properly to e.g. `/Users/maebert`
* __1.5.6__ Fixed: Fixed a bug where on OS X, the timezone could only be accessed on administrator accounts.
* __1.5.5__ Fixed: Detects DayOne journals stored in `~/Library/Mobile Data` as well.
* __1.5.4__ DayOne journals can now handle tags
* __1.5.3__ Fixed: DayOne integration with older DayOne Journals
* __1.5.2__ Soft-deprecated `-to` for filtering by time and introduces `-until` instead.
* __1.5.1__ Fixed: Fixed a bug introduced in 1.5.0 that caused the entire journal to be printed after composing an entry
* __1.5.0__ Exporting, encrypting and displaying tags now takes your filter options into account. So you could export everything before May 2012: `jrnl -to 'may 2012' --export json`. Or encrypt all entries tagged with `@work` into a new journal: `jrnl @work --encrypt work_journal.txt`. Or display all tags of posts where Bob is also tagged: `jrnl @bob --tags`
## v1.4 (2013-07-22)
* __1.4.2__ Fixed: Tagging works again
* __1.4.0__ Unifies encryption between Python 2 and 3. If you have problems reading encrypted journals afterwards, first decrypt your journal with the __old__ jrnl version (install with `pip install jrnl==1.3.1`, then `jrnl --decrypt`), upgrade jrnl (`pip install jrnl --upgrade`) and encrypt it again (`jrnl --encrypt`).
## v1.3 (2013-07-17)
* __1.3.2__ Everything that is not direct output of jrnl will be written stderr to improve integration
* __1.3.0__ Export to multiple files
* __1.3.0__ Feature to export to given output file
## v1.2 (2013-07-15)
* __1.2.0__ Fixed: Timezone support for DayOne
## v1.1 (2013-06-09)
* __1.1.1__ Fixed: Unicode and Python3 issues resolved.
* __1.1.0__
* JSON export exports tags as well.
* Nicer error message when there is a syntactical error in your config file.
* Unicode support
## v1.0 (2013-03-04)
* __1.0.5__ Backwards compatibility with `parsedatetime` 0.8.7
* __1.0.4__
* Python 2.6 compatibility
* Better utf-8 support
* Python 3 compatibility
* Respects the `XDG_CONFIG_HOME` environment variable for storing your configuration file (Thanks [evaryont](https://github.com/evaryont))
* __1.0.3__
* Removed clint in favour of colorama
* Fixed: Fixed a bug where showing tags failed when no tags are defined.
* Fixed: Improvements to config parsing (Thanks [alapolloni](https://github.com/alapolloni))
* Fixed: Fixes readline support on Windows
* Fixed: Smaller fixes and typos
* __1.0.1__ (March 12, 2013) Fixed: Requires parsedatetime 1.1.2 or newer
* __1.0.0__
* Integrates seamlessly with DayOne
* Each journal can have individual settings
* Fixed: A bug where jrnl would not go into compose mode
* Fixed: A bug where jrnl would not add entries without timestamp
* Fixed: Support for parsedatetime 1.x
## v0.3 (2012-05-24)
* __0.3.2__ Converts `\n` to new lines (if using directly on a command line, make sure to wrap your entry with quotes).
* __0.3.1__
* Supports deleting of last entry.
* Fixed: Fixes a bug where --encrypt or --decrypt without a target file would not work.
* Supports a config option for setting word wrap.
* Supports multiple journal files.
* __0.3.0__
* Fixed: Dates such as "May 3" will now be interpreted as being in the past if the current day is at least 28 days in the future
* Fixed: Bug where composed entry is lost when the journal file fails to load
* Changed directory structure and install scripts (removing the necessity to make an alias from `jrnl` to `jrnl.py`)
## v0.2 (2012-04-16)
* __0.2.4__
* Fixed: Parsing of new lines in journal files and entries
* Adds support for encrypting and decrypting into new files
* __0.2.3__
* Adds a `-short` option that will only display the titles of entries (or, when filtering by tags, the context of the tag)
* Adds tag export
* Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags)
* `.jrnl_config` will get automatically updated when updating jrnl to a new version
* __0.2.2__
* Adds --encrypt and --decrypt to encrypt / decrypt existing journal files
* Adds markdown export (kudos to dedan)
* __0.2.1__ Submitted to [PyPi](http://pypi.python.org/pypi/jrnl/0.2.1).
* __0.2.0__
* Encrypts using CBC
* Fixed: `key` has been renamed to `password` in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.)
## v0.1 (2012-04-13)
* __0.1.1__
* Fixed: Removed unnecessary print commands
* Created the documentation
* __0.1.0__
* Supports encrypted journals using AES encryption
* Support external editors for composing entries
* __0.0.2__
* Filtering by tags and dates
* Fixed: Now using dedicated classes for Journals and entries
## v0.0 (2012-03-29)
* __0.0.1__ Composing entries works. That's pretty much it.
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by [emailing the maintainers](mailto:maintainers@jrnl.sh).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
================================================
FILE: CONTRIBUTING.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Contributing
See "[Contributing](docs/contributing.md)" in the `docs` directory.
================================================
FILE: LICENSE.md
================================================
### GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
<https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
### Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom
to share and change all versions of a program--to make sure it remains
free software for all its users. We, the Free Software Foundation, use
the GNU General Public License for most of our software; it applies
also to any other work released this way by its authors. You can apply
it to your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you
have certain responsibilities if you distribute copies of the
software, or if you modify it: responsibilities to respect the freedom
of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so. This is fundamentally incompatible with the
aim of protecting users' freedom to change the software. The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products. If such problems arise substantially in
other domains, we stand ready to extend this provision to those
domains in future versions of the GPL, as needed to protect the
freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish
to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL
assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
### TERMS AND CONDITIONS
#### 0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a "modified version" of
the earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.
An interactive user interface displays "Appropriate Legal Notices" to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
#### 1. Source Code.
The "source code" for a work means the preferred form of the work for
making modifications to it. "Object code" means any non-source form of
a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same
work.
#### 2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10 makes
it unnecessary.
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work's users, your or third parties' legal rights to forbid
circumvention of technological measures.
#### 4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
#### 5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:
- a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
- b) The work must carry prominent notices stating that it is
released under this License and any conditions added under
section 7. This requirement modifies the requirement in section 4
to "keep intact all notices".
- c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
#### 6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:
- a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
- b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the Corresponding
Source from a network server at no charge.
- c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
- d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission,
provided you inform other peers where the object code and
Corresponding Source of the work are being offered to the general
public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
"normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
#### 7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
- c) Prohibiting misrepresentation of the origin of that material,
or requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors
or authors of the material; or
- e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions
of it) with contractual assumptions of liability to the recipient,
for any liability that these contractual assumptions directly
impose on those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.
#### 8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
#### 9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
#### 10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
#### 11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
#### 12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree to
terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
#### 13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
#### 14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions
of the GNU General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that numbered version or
of any later version published by the Free Software Foundation. If the
Program does not specify a version number of the GNU General Public
License, you may choose any version ever published by the Free
Software Foundation.
If the Program specifies that a proxy can decide which future versions
of the GNU General Public License can be used, that proxy's public
statement of acceptance of a version permanently authorizes you to
choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
#### 15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
#### 16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
#### 17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
### How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper
mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands \`show w' and \`show c' should show the
appropriate parts of the General Public License. Of course, your
program's commands might be different; for a GUI interface, you would
use an "about box".
You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Lesser General Public License instead of this License. But first,
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
================================================
FILE: README.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
<p align="center">
<a href="https://jrnl.sh">
<img align="center" src="https://raw.githubusercontent.com/jrnl-org/jrnl/develop/docs_theme/assets/readme-header.png"/>
</a>
</p>
jrnl
[](https://github.com/jrnl-org/jrnl/actions?query=workflow%3ATesting)
[](https://pepy.tech/project/jrnl)
[](https://pypi.python.org/pypi/jrnl/)
[](https://formulae.brew.sh/formula/jrnl)
[](https://gitter.im/jrnl-org/jrnl)
[](https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md)
====
_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new/choose) on
GitHub._
`jrnl` is a simple journal application for the command line.
You can use it to easily create, search, and view journal entries. Journals are
stored as human-readable plain text, and can also be encrypted using [AES
encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
## In a Nutshell
To make a new entry, just enter
``` sh
jrnl yesterday: Called in sick. Used the time to clean the house and write my
book.
```
`yesterday:` is interpreted by `jrnl` as a timestamp. Everything until the
first sentence ending (either `.`, `?`, or `!`) is interpreted as the title, and
the rest as the body. In your journal file, the result will look like this:
[2012-03-29 09:00] Called in sick.
Used the time to clean the house and write my book.
If you just call `jrnl`, you will be prompted to compose your entry - but you
can also configure _jrnl_ to use your external editor.
For more information, please read the
[documentation](https://jrnl.sh).
## Contributors
### Maintainers
Our maintainers help keep the lights on for the project:
* Jonathan Wren ([wren](https://github.com/wren))
* Micah Ellison ([micahellison](https://github.com/micahellison))
Please thank them if you like `jrnl`!
### Code Contributors
This project is made with love by the many fabulous people who have contributed.
`jrnl` couldn't exist without each and every one of you!
<a href="https://github.com/jrnl-org/jrnl/graphs/contributors"><img
src="https://opencollective.com/jrnl/contributors.svg?width=890&button=false"
/></a>
If you'd also like to help make `jrnl` better, please see our [contributing
documentation](docs/contributing.md).
### Financial Backers
Another way show support is through direct financial contributions. These funds
go to covering our costs, and are a quick way to show your appreciation for
`jrnl`.
[Become a financial contributor](https://opencollective.com/jrnl/contribute)
and help us sustain our community.
<a href="https://opencollective.com/jrnl"><img
src="https://opencollective.com/jrnl/individuals.svg?width=890"></a>
================================================
FILE: SECURITY.md
================================================
# Security
If you've discovered a potential security issue in jrnl, please contact the maintainers at [maintainers@jrnl.sh](mailto:maintainers@jrnl.sh).
You can also feel free to [open an issue](https://github.com/jrnl-org/jrnl/issues/new/choose) (but please don't disclose the vulnerability) in case the email goes to spam.
You can find [known privacy and security issues in our documentation](https://jrnl.sh/en/stable/privacy-and-security/).
================================================
FILE: docs/advanced.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Advanced Usage
## Configuration File
`jrnl` has a wide variety of options that can be customized through the config file,
including templates, formats, multiple journals, and more. See
the [configuration file reference](./reference-config-file.md) for details
or read on for some common use cases.
### Multiple journal files
You can configure `jrnl`to use with multiple journals (eg.
`private` and `work`) by defining more journals in your [config file](./reference-config-file.md),
for example:
``` yaml
journals:
default: ~/journal.txt
work: ~/work.txt
```
The `default` journal gets created the first time you start `jrnl`
Now you can access the `work` journal by using `jrnl work` instead of
`jrnl`, eg.
``` sh
jrnl work at 10am: Meeting with @Steve
jrnl work -n 3
```
will both use `~/work.txt`, while `jrnl -n 3` will display the last
three entries from `~/journal.txt` (and so does `jrnl default -n 3`).
You can also override the default options for each individual journal.
If your `jrnl.yaml` looks like this:
``` yaml
encrypt: false
journals:
default: ~/journal.txt
work:
journal: ~/work.txt
encrypt: true
food: ~/my_recipes.txt
```
Your `default` and your `food` journals won't be encrypted, however your
`work` journal will!
You can override all options that are present at
the top level of `jrnl.yaml`, just make sure that at the very least
you specify a `journal: ...` key that points to the journal file of
that journal.
Consider the following example configuration
``` yaml
editor: vi -c startinsert
journals:
default: ~/journal.txt
work:
journal: ~/work.txt
encrypt: true
display_format: json
editor: code -rw
food:
display_format: markdown
journal: ~/recipes.txt
```
The `work` journal is encrypted, prints to `json` by default, and is edited using an existing window of VSCode. Similarly, the `food` journal prints to markdown by default, but uses all the other defaults.
### Modifying Configurations from the Command line
You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot notation and `CONFIG_VALUE` is the (valid) desired override value. The dot notation can be used to change config keys within other keys, such as `colors.title` for the `title` key within the `colors` key.
You can specify multiple overrides as multiple calls to `--config-override`.
!!! note
These overrides allow you to modify ***any*** field of your jrnl configuration. We trust that you know what you are doing.
#### Examples:
``` sh
# Create an entry using the `stdin` prompt, for rapid logging
jrnl --config-override editor ""
# Populate a project's log
jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo find my towel
# Pass multiple overrides
jrnl --config-override display_format fancy --config-override linewrap 20 \
--config-override colors.title green
```
### Using an alternate config
You can specify an alternate configuration file for the current instance of `jrnl` using `--config-file CONFIG_FILE_PATH` where
`CONFIG_FILE_PATH` is a path to an alternate `jrnl` configuration file.
#### Examples:
``` sh
# Use personalised configuration file for personal journal entries
jrnl --config-file ~/foo/jrnl/personal-config.yaml
# Use alternate configuration file for work-related entries
jrnl --config-file ~/foo/jrnl/work-config.yaml
# Use default configuration file (created on first run)
jrnl
```
================================================
FILE: docs/contributing.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Contributing to jrnl
We welcome contributions to jrnl, whether it's through reporting bugs, improving the documentation, testing releases, engaging in discussion on features and bugs, or writing code.
## Table of Contents
* [Code of Conduct](#code-of-conduct)
* [Reporting Bugs](#reporting-bugs)
* [Editing Documentation](#editing-documentation)
* [Testing](#testing)
* [Submitting feature requests and ideas](#submitting-feature-requests-and-ideas)
* [Developing jrnl](#developing)
## Code of Conduct
Before starting, please read the [Code of Conduct](https://github.com/jrnl-org/jrnl/blob/develop/CODE_OF_CONDUCT.md).
## Reporting Bugs
Please report bugs by [opening a new issue](https://github.com/jrnl-org/jrnl/issues/new/choose) and describing it as well as possible. Many bugs are specific to a particular operating system and Python version, so please include that information!
## Editing Documentation
If you find a typo or a mistake in the docs, please fix it right away and send a pull request. If you're unsure what to change but still see a problem, you can [open a new issue](https://github.com/jrnl-org/jrnl/issues/new/choose) with the "Documentation change" type.
To edit the documentation, edit the `docs/*.md` files on the **develop** branch. You can see the result by running `poe docs-run` inside the project's root directory, then navigating your browser to [localhost:8000](http://localhost:8000).
### External editors and tips and tricks
If you'd like to share a jrnl command line trick that you find useful, you may find it worthwhile to add it to the ["Tips and Tricks" section](tips-and-tricks.md). For advice on how to integrate a particular external editor, you can add to the ["External Editors" section](external-editors.md).
## Testing
Much of the work of maintaining jrnl involves testing rather than coding.
The nature of jrnl means we deal with extremely sensitive data, and can't risk data loss. While jrnl does have a comprehensive automated testing suite, user testing is crucial to mitigating this risk.
### Prereleases
[Prereleases are deployed through PyPi much like normal releases](https://pypi.org/project/jrnl/#history). You can use [pipx](https://pypi.org/project/pipx/) to fetch them and test them. See the [changelog](https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md) for information on what has changed with each release.
### Pull requests
If you are comfortable enough with git, feel free to fetch particular [pull requests](https://github.com/jrnl-org/jrnl/pulls), test them yourself, and report back your findings. Bonus points if you can add a screencast of how the new feature works.
### Confirm bug reports
There are always [open bugs among our GitHub issues](https://github.com/jrnl-org/jrnl/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and many are specific to a particular OS, Python version, or jrnl version. A simple comment like "Confirmed on jrnl v2.2, MacOS 10.15, Python 3.8.1" would be extremely helpful in tracking down bugs.
### Automate tests
See the develop section below for information on how to contribute new automated tests.
## Submitting feature requests and ideas
If you have a feature request or idea for jrnl, please [open a new issue](https://github.com/jrnl-org/jrnl/issues/new/choose) and describe the goal of the feature, and any relevant use cases. We'll discuss the issue with you, and decide if it's a good fit for the project.
When discussing new features, please keep in mind our design goals. jrnl strives to
[do one thing well](https://en.wikipedia.org/wiki/Unix_philosophy). To us, that means:
* being _nimble_
* having a simple interface
* avoiding duplicating functionality
## Developing
### Getting your environment set up
You will need to install [poetry](https://python-poetry.org/) to develop jrnl. It will take care of all of the project's other dependencies.
### Understanding the branches
jrnl uses two primary branches:
* `develop` - for ongoing development
* `release` - for releases
In general, pull requests should be made on the `develop` branch.
### Common development commands
You can find an inventory of commands in the `pyproject.toml`. Users can run the commands by typing `poe` followed by the name of the command ([Poe the Poet](https://github.com/nat-n/poethepoet) can be installed on its own, or as part of `poetry install`).
A typical development workflow includes:
* Installing dependencies:
* `poetry install`
* Activate virtual environment:
* `poetry shell`
* Running the source in a virtual environment:
* `jrnl` (with or without arguments as necessary)
* Running tests:
* `poe test`
* Formatting the code to standardize its style:
* `poe format`
### Updating automated tests
When resolving bugs or adding new functionality, please add tests to prevent that functionality from breaking in the future. If you notice any functionality that isn't covered in the tests, feel free to submit a test-only pull request as well.
For testing, jrnl uses [pytest](https://docs.pytest.org) for unit tests, and [pytest-bdd](https://pytest-bdd.readthedocs.io/) for integration testing. All tests are in the `tests` folder.
Many tests can be created by only editing `*.feature` files with the same format as other tests. For more complicated functionality, you may need to implement steps in `tests/lib/` which are then executed by your tests in the `feature` files.
### Submitting pull requests
When you're ready, feel free to submit a pull request (PR). The jrnl maintainers generally review the pull requests every two weeks, but the continuous integration pipeline will run on automated tests on it within a matter of minutes and will report back any issues it has found with your code across a variety of environments.
The pull request template contains a checklist full of housekeeping items. Please fill them out as necessary when you submit.
If a pull request contains failing tests, it probably will not be reviewed, and it definitely will not be approved. However, if you need help resolving a failing test, please mention that in your PR.
### Finding things to work on
You can search the [jrnl GitHub issues](https://github.com/jrnl-org/jrnl/issues) by [label](https://github.com/jrnl-org/jrnl/labels) for things to work on. Here are some labels worth searching:
* [critical](https://github.com/jrnl-org/jrnl/labels/critical)
* [help wanted](https://github.com/jrnl-org/jrnl/labels/help%20wanted)
* [bug](https://github.com/jrnl-org/jrnl/labels/bug)
* [enhancement](https://github.com/jrnl-org/jrnl/labels/enhancement)
You can also get a feel for the project's priorities by reviewing the [milestones](https://github.com/jrnl-org/jrnl/milestones).
### A note for new programmers and programmers new to python
Although jrnl has grown quite a bit since its inception, the overall complexity (for an end-user program) is fairly low, and we hope you'll find the code easy enough to understand.
If you have a question, please don't hesitate to ask! Python is known for its welcoming community and openness to novice programmers, so feel free to fork the code and play around with it! If you create something you want to share with us, please create a pull request. We never expect pull requests to be perfect, idiomatic, instantly mergeable code. We can work through it together!
================================================
FILE: docs/encryption.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Encryption
## A Note on Security
While `jrnl` follows best practices, total security is never possible in the
real world. There are a number of ways that people can at least partially
compromise your `jrnl` data. See the [Privacy and Security](./privacy-and-security.md) page
for more information.
## Encrypting and Decrypting
Existing plain text journal files can be encrypted using the `--encrypt`
command:
``` sh
jrnl --encrypt [FILENAME]
```
You can then enter a new password, and the unencrypted file will replaced with
the new encrypted file.
This command also works to change the password for a journal file that is
already encrypted. `jrnl` will prompt you for the current password and then new
password.
Conversely,
``` sh
jrnl --decrypt [FILENAME]
```
replaces the encrypted journal file with a plain text file. You can also specify
a filename, e.g., `jrnl --decrypt plain_text_copy.txt`, to leave the original
encrypted file untouched and create a new plain text file next to it.
!!! note
Changing `encrypt` in your [config file](./reference-config-file.md) to
a different value will not encrypt or decrypt your
journal file. It merely says whether or not your journal
is encrypted. Hence manually changing
this option will most likely result in your journal file being
impossible to load. This is why the above commands are necessary.
## Storing Passwords in Your Keychain
Nobody can recover or reset your `jrnl` password. If you lose it,
your data will be inaccessible forever.
For this reason, when encrypting a journal, `jrnl` asks whether you would like
to store the password in your system's keychain. An added benefit is that you
will not need to enter the password when interacting with the journal file.
If you don't initially store the password in your keychain but decide to do so
later---or if you want to store it in one computer's keychain but not in another
computer's---you can run `jrnl --encrypt` on an encrypted journal and use the
same password again. This will trigger the keychain storage prompt.
## Manual Decryption
The easiest way to decrypt your journal is with `jrnl --decrypt`, but you could
also decrypt your journal manually if needed. To do this, you can use any
program that supports the AES algorithm (specifically AES-CBC), and you'll need
the following relevant information for decryption:
- **Key:** The key used for encryption is the
[SHA-256](https://en.wikipedia.org/wiki/SHA-2) hash of your password.
- **Initialization vector (IV):** The IV is stored in the first 16 bytes of
your encrypted journal file.
- **The actual text of the journal** (everything after the first 16 bytes in
the encrypted journal file) is encoded in
[UTF-8](https://en.wikipedia.org/wiki/UTF-8) and padded according to
[PKCS\#7](https://en.wikipedia.org/wiki/PKCS_7) before being encrypted.
If you'd like an example of what this might look like in script form, please
see below for some examples of Python scripts that you could use to manually
decrypt your journal.
!!! note
These are only examples, and are only here to illustrate that your journal files
will still be recoverable even if `jrnl` isn't around anymore. Please use
`jrnl --decrypt` if available.
**Example for jrnl v2 files**:
``` python
#!/usr/bin/env python3
"""
Decrypt a jrnl v2 encrypted journal.
Note: the `cryptography` module must be installed (you can do this with
something like `pip3 install crytography`)
"""
import base64
import getpass
from pathlib import Path
from cryptography.fernet import Fernet
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
filepath = input("journal file path: ")
password = getpass.getpass("Password: ")
with open(Path(filepath), "rb") as f:
ciphertext = f.read()
password = password.encode("utf-8")
kdf = PBKDF2HMAC(
algorithm=hashes.SHA256(),
length=32,
salt=b"\xf2\xd5q\x0e\xc1\x8d.\xde\xdc\x8e6t\x89\x04\xce\xf8",
iterations=100_000,
backend=default_backend(),
)
key = base64.urlsafe_b64encode(kdf.derive(password))
print(Fernet(key).decrypt(ciphertext).decode("utf-8"))
```
**Example for jrnl v1 files**:
``` python
#!/usr/bin/env python3
"""
Decrypt a jrnl v1 encrypted journal.
Note: the `pycrypto` module must be installed (you can do this with something
like `pip3 install pycrypto`)
"""
import argparse
import getpass
import hashlib
from Crypto.Cipher import AES
parser = argparse.ArgumentParser()
parser.add_argument("filepath", help="journal file to decrypt")
args = parser.parse_args()
pwd = getpass.getpass()
key = hashlib.sha256(pwd.encode("utf-8")).digest()
with open(args.filepath, "rb") as f:
ciphertext = f.read()
crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
plain = crypto.decrypt(ciphertext[16:])
plain = plain.strip(plain[-1:])
plain = plain.decode("utf-8")
print(plain)
```
================================================
FILE: docs/external-editors.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# External editors
Configure your preferred external editor by updating the `editor` option
in your [configuration file](./reference-config-file.md#editor). If your editor is not
in your operating system's `PATH` environment variable, then you will have to
enter the full path of your editor.
Once it's configured, you can create an entry as a new document in your editor using the `jrnl`
command by itself:
``` text
jrnl
```
You can specify the time and title of the entry as usual on the first line of the document.
If you want, you can skip the editor by including a quick entry with the `jrnl` command:
``` text
jrnl yesterday: All my troubles seemed so far away.
```
If you want to start the entry on the command line and continue writing in your chosen editor,
use the `--edit` flag. For example:
``` text
jrnl yesterday: All my troubles seemed so far away. --edit
```
!!! note
To save and log any entry edits, save and close the file.
All editors must be [blocking processes](https://en.wikipedia.org/wiki/Blocking_(computing)) to work with jrnl. Some editors, such as [micro](https://micro-editor.github.io/), are blocking by default, though others can be made to block with additional arguments, such as many of those documented below. If jrnl opens your editor but finishes running immediately, then your editor is not a blocking process, and you may be able to correct that with one of the suggestions below.
Please see [this section](./privacy-and-security.md#editor-history) about how
your editor might leak sensitive information and how to mitigate that risk.
## Sublime Text
To use [Sublime Text](https://www.sublimetext.com/), install the command line
tools for Sublime Text and configure your `jrnl.yaml` like this:
```yaml
editor: "subl -w"
```
Note the `-w` flag to make sure `jrnl` waits for Sublime Text to close the
file before writing into the journal.
## Visual Studio Code
[Visual Studio Code](https://code.visualstudio.com) also requires a flag
that tells the process to wait until the file is closed before exiting:
```yaml
editor: "code --wait"
```
On Windows, `code` is not added to the path by default, so you'll need to
enter the full path to your `code.exe` file, or add it to the `PATH` variable.
## MacVim
Also similar to Sublime Text, MacVim must be started with a flag that tells
the the process to wait until the file is closed before passing control
back to journal. In the case of MacVim, this is `-f`:
```yaml
editor: "mvim -f"
```
## Vim/Neovim
To use any of the Vim derivatives as editor in Linux, simply set the `editor`
to the executable:
```yaml
editor: "vim"
# or
editor: "nvim"
```
## iA Writer
On OS X, you can use the fabulous [iA
Writer](http://www.iawriter.com/mac) to write entries. Configure your
`jrnl.yaml` like this:
```yaml
editor: "open -b pro.writer.mac -Wn"
```
What does this do? `open -b ...` opens a file using the application
identified by the bundle identifier (a unique string for every app out
there). `-Wn` tells the application to wait until it's closed before
passing back control, and to use a new instance of the application.
If the `pro.writer.mac` bundle identifier is not found on your system,
you can find the right string to use by inspecting iA Writer's
`Info.plist` file in your shell:
```sh
grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
```
## Notepad++ on Windows
To set [Notepad++](http://notepad-plus-plus.org/) as your editor, edit
the `jrnl` config file (`jrnl.yaml`) like this:
```yaml
editor: "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession"
```
The double backslashes are needed so `jrnl` can read the file path
correctly. The `-multiInst -nosession` options will cause `jrnl` to open
its own Notepad++ window.
## emacs
To use `emacs` as your editor, edit the `jrnl` config file (`jrnl.yaml`) like this:
```yaml
editor: emacsclient -a "" -c
```
When you're done editing the message, save and `C-x #` to close the buffer and stop the emacsclient process.
## Other editors
If you're using another editor and would like to share, feel free to [contribute documentation](./contributing.md#editing-documentation) on it.
================================================
FILE: docs/formats.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Formats
`jrnl` supports a variety of alternate formats. These can be used to display your
journal in a different manner than the `jrnl` default, and can even be used to pipe data
from your journal for use in another program to create reports, or do whatever you want
with your `jrnl` data.
Any of these formats can be used with a search (e.g. `jrnl -contains "lorem ipsum"
--format json`) to display the results of that search in the given format, or can be
used alone (e.g. `jrnl --format json`) to display all entries from the selected journal.
This page shows examples of all the built-in formats, but since `jrnl` supports adding
more formats through plugins, you may have more available on your system. Please see
`jrnl --help` for a list of which formats are available on your system.
Any of these formats can be used interchangeably, and are only grouped into "display",
"data", and "report" formats below for convenience.
## Display Formats
These formats are mainly intended for displaying your journal in the terminal. Even so,
they can still be used in the same way as any other format (like written to a file, if
you choose).
### Pretty
``` sh
jrnl --format pretty
# or
jrnl -1 # any search
```
This is the default format in `jrnl`. If no `--format` is given, `pretty` will be used.
It displays the timestamp of each entry formatted to by the user config followed by the
title on the same line. Then the body of the entry is shown below.
This format is configurable through these values from your config file (see
[Advanced Usage](./advanced.md) for more details):
- `colors`
- `body`
- `date`
- `tags`
- `title`
- `indent_character`
- `linewrap`
- `timeformat`
**Example output**:
``` sh
2020-06-28 18:22 This is the first sample entry
| This is the sample body text of the first sample entry.
2020-07-01 20:00 This is the second sample entry
| This is the sample body text of the second sample entry, but
| this one has a @tag.
2020-07-02 09:00 This is the third sample entry
| This is the sample body text of the third sample entry.
```
### Short
``` sh
jrnl --format short
# or
jrnl --short
```
This will shorten entries to display only the date and title. It is essentially the
`pretty` format but without the body of each entry. This can be useful if you have long
journal entries and only want to see a list of entries that match your search.
**Example output**:
``` sh
2020-06-28 18:22 This is the first sample entry
2020-07-01 20:00 This is the second sample entry
2020-07-02 09:00 This is the third sample entry
```
### Fancy (or Boxed)
``` sh
jrnl --format fancy
# or
jrnl --format boxed
```
This format outlines each entry with a border. This makes it much easier to tell where
each entry starts and ends. It's an example of how free-form the formats can be, and also
just looks kinda ~*~fancy~*~, if you're into that kind of thing.
**Example output**:
``` sh
┎──────────────────────────────────────────────────────────────────────╮2020-06-28 18:22
┃ This is the first sample entry ╘═══════════════╕
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
┃ This is the sample body text of the first sample entry. │
┖──────────────────────────────────────────────────────────────────────────────────────┘
┎──────────────────────────────────────────────────────────────────────╮2020-07-01 20:00
┃ This is the second sample entry ╘═══════════════╕
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
┃ This is the sample body text of the second sample entry, but this one has a @tag. │
┖──────────────────────────────────────────────────────────────────────────────────────┘
┎──────────────────────────────────────────────────────────────────────╮2020-07-02 09:00
┃ This is the third sample entry ╘═══════════════╕
┠╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
┃ This is the sample body text of the third sample entry. │
┖──────────────────────────────────────────────────────────────────────────────────────┘
```
## Data Formats
These formats are mainly intended for piping or exporting your journal to other
programs. Even so, they can still be used in the same way as any other format (like
written to a file, or displayed in your terminal, if you want).
!!! note
You may see boxed messages like "2 entries found" when using these formats, but
those messages are written to `stderr` instead of `stdout`, and won't be piped when
using the `|` operator.
### JSON
``` sh
jrnl --format json
```
JSON is a very handy format used by many programs and has support in nearly every
programming language. There are many things you could do with JSON data. Maybe you could
use `jq` ([project page](https://github.com/stedolan/jq)) to filter through the fields in your journal.
Like this:
``` sh
$ j -3 --format json | jq '.entries[].date' jrnl-GFqVlfgP-py3.8
"2020-06-28"
"2020-07-01"
"2020-07-02"
```
Or why not create a [beautiful timeline](http://timeline.knightlab.com/) of your journal?
**Example output**:
``` json
{
"tags": {
"@tag": 1
},
"entries": [
{
"title": "This is the first sample entry",
"body": "This is the sample body text of the first sample entry.",
"date": "2020-06-28",
"time": "18:22",
"tags": [],
"starred": false
},
{
"title": "This is the second sample entry",
"body": "This is the sample body text of the second sample entry, but this one has a @tag.",
"date": "2020-07-01",
"time": "20:00",
"tags": [
"@tag"
],
"starred": false
},
{
"title": "This is the third sample entry",
"body": "This is the sample body text of the third sample entry.",
"date": "2020-07-02",
"time": "09:00",
"tags": [],
"starred": false
}
]
}
```
### Markdown
``` sh
jrnl --format markdown
# or
jrnl --format md
```
Markdown is a simple markup language that is human readable and can be used to be
rendered to other formats (html, pdf). `jrnl`'s
[README](https://github.com/jrnl-org/jrnl/blob/develop/README.md) for example is
formatted in markdown, then Github adds some formatting to make it look nice.
The markdown format groups entries by date (first by year, then by month), and adds
header markings as needed (e.g. `#`, `##`, etc). If you already have markdown header
markings in your journal, they will be incremented as necessary to make them fit under
these new headers (i.e. `#` will become `##`).
This format can be very useful, for example, to export a journal to a program that
converts markdown to html to make a website or a blog from your journal.
**Example output**:
``` markdown
# 2020
## June
### 2020-06-28 18:22 This is the first sample entry
This is the sample body text of the first sample entry.
## July
### 2020-07-01 20:00 This is the second sample entry
This is the sample body text of the second sample entry, but this one has a @tag.
### 2020-07-02 09:00 This is the third sample entry
This is the sample body text of the third sample entry.
```
### Plain Text
``` sh
jrnl --format text
# or
jrnl --format txt
```
This outputs your journal in the same plain-text format that `jrnl` uses to store your
journal on disk. This format is particularly useful for importing and exporting journals
within `jrnl`.
You can use it, for example, to move entries from one journal to another, or to create a
new journal with search results from another journal.
**Example output**:
``` sh
[2020-06-28 18:22] This is the first sample entry
This is the sample body text of the first sample entry.
[2020-07-01 20:00] This is the second sample entry
This is the sample body text of the second sample entry, but this one has a @tag.
[2020-07-02 09:00] This is the third sample entry
This is the sample body text of the third sample entry.
```
### XML
``` sh
jrnl --format xml
```
This outputs your journal into XML format. XML is a commonly used data format and is
supported by many programs and programming languages.
**Example output**:
``` xml
<?xml version="1.0" ?>
<journal>
<entries>
<entry date="2020-06-28T18:22:00" starred="">This is the first sample entry This is the sample body text of the first sample entry.</entry>
<entry date="2020-07-01T20:00:00" starred="">
<tag name="@tag"/>
This is the second sample entry This is the sample body text of the second sample entry, but this one has a @tag.
</entry>
<entry date="2020-07-02T09:00:00" starred="">*This is the third sample entry, and is starred This is the sample body text of the third sample entry.</entry>
</entries>
<tags>
<tag name="@tag">1</tag>
</tags>
</journal>
```
### YAML
``` sh
jrnl --format yaml --file 'my_directory/'
```
This outputs your journal into YAML format. YAML is a commonly used data format and is
supported by many programs and programming languages. [Exporting to directories](#exporting-to-directories) is the
only supported YAML export option and each entry will be written to a separate file.
**Example file**:
``` yaml
title: This is the second sample entry
date: 2020-07-01 20:00
starred: False
tags: tag
This is the sample body text of the second sample entry, but this one has a @tag.
```
## Report formats
Since formats use your journal data and display it in different ways, they can also be
used to create reports.
### Tags
``` sh
jrnl --format tags
# or
jrnl --tags
```
This format is a simple example of how formats can be used to create reports. It
displays each tag, and a count of how many entries in which tag appears in your journal
(or in the search results), sorted by most frequent.
Example output:
``` sh
@one : 32
@two : 17
@three : 4
```
## Options
### Exporting with `--file`
Example: `jrnl --format json --file /some/path/to/a/file.txt`
By default, `jrnl` will output entries to your terminal. But if you provide `--file`
along with a filename, the same output that would have been to your terminal will be
written to the file instead. This is the same as piping the output to a file.
So, in bash for example, the following two statements are equivalent:
``` sh
jrnl --format json --file myjournal.json
```
``` sh
jrnl --format json > myjournal.json
```
#### Exporting to directories
If the `--file` argument is a directory, jrnl will export each entry into an individual file:
``` sh
jrnl --format yaml --file my_entries/
```
The contents of `my_entries/` will then look like this:
``` output
my_entries/
|- 2013_06_03_a-beautiful-day.yaml
|- 2013_06_07_dinner-with-gabriel.yaml
|- ...
```
================================================
FILE: docs/installation.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Getting started
## Installation
The easiest way to install `jrnl` is using
[pipx](https://pipx.pypa.io/stable/installation/)
with [Python](https://www.python.org/) 3.10+:
``` sh
pipx install jrnl
```
!!! tip
Do not use `sudo` while installing `jrnl`. This may lead to path issues.
The first time you run `jrnl` you will be asked where your journal file
should be created and whether you wish to encrypt it.
## Quickstart
To make a new entry, just type
``` text
jrnl yesterday: Called in sick. Used the time to clean, and spent 4h on writing my book.
```
and hit return. `yesterday:` will be interpreted as a time stamp.
Everything until the first sentence mark (`.?!:`) will be interpreted as
the title, the rest as the body. In your journal file, the result will
look like this:
``` output
2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book.
```
If you just call `jrnl`, you will be prompted to compose your entry -
but you can also [configure](advanced.md) *jrnl* to use your external editor.
================================================
FILE: docs/journal-types.md
================================================
<!--
Copyright © 2012-2023 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html
-->
# Journal Types
`jrnl` can store your journal in a few different ways:
- a single text file (encrypted or otherwise)
- a folder structure organized by date containing unencrypted text files
- the DayOne Classic format
There is no need to specify what type of journal you'd like to use. Instead,
`jrnl` will automatically detect the journal type based on whether you're
referencing a file or a folder in your [config file](advanced.md),
and if it's a folder, whether or not DayOne Classic content exists in it.
## Single File
The single file format is the most flexible, as it can be [encrypted](encryption.md).
To use it, enter any path that is a file or does not already exist. You can
use any extension. `jrnl` will automatically create the file when you save
your first entry.
## Folder
The folder journal format organizes your entries into subfolders for the year
and month and `.txt` files for each day. If there are multiple entries in a day,
they all appear in the same `.txt` file.
The directory tree structure is in this format: `YYYY/MM/DD.txt`. For instance, if
you have an entry on May 5th, 2021 in a folder journal at `~/folderjournal`, it will
be located in: `~/folderjournal/2021/05/05.txt`
!!! note
Creating a new folder journal can be done in two ways:
* Create a folder with the name of the journal before running `jrnl`. Otherwise, when you run `jrnl` for the first time, it will assume that you are creating a single file journal instead, and it will create a file at that path.
* Create a new journal in your [config_file](advanced.md) and end the path with a ``/`` (on a POSIX system like Linux or MacOSX) or a ``\`` (on a Windows system). The folder will be created automatically if it doesn't exist.
!!! note
Folder journals can't be encrypted.
## Day One Classic
`jrnl` supports the original data format used by DayOne. It's similar to the folder
journal format, except it's identified by either of these characteristics:
* the folder has a `.dayone` extension
* the folder has a subfolder named `entries`
This is not to be confu
gitextract_j41touky/
├── .build/
│ └── allow_all_python_version.py
├── .gitattributes
├── .github/
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.yaml
│ │ ├── config.yml
│ │ ├── documentation.yaml
│ │ ├── feature_request.yaml
│ │ └── support_request.yaml
│ ├── PULL_REQUEST_TEMPLATE.md
│ ├── actionlint-matcher.json
│ ├── actions/
│ │ └── run_tests/
│ │ └── action.yaml
│ ├── lock.yml
│ ├── renovate.json
│ ├── stale.yml
│ └── workflows/
│ ├── changelog.yaml
│ ├── docs.yaml
│ ├── release.yaml
│ ├── testing_pipelines.yaml
│ ├── testing_prs.yaml
│ └── testing_schedule.yaml
├── .gitignore
├── .readthedocs.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── SECURITY.md
├── docs/
│ ├── advanced.md
│ ├── contributing.md
│ ├── encryption.md
│ ├── external-editors.md
│ ├── formats.md
│ ├── installation.md
│ ├── journal-types.md
│ ├── overview.md
│ ├── privacy-and-security.md
│ ├── reference-command-line.md
│ ├── reference-config-file.md
│ ├── tips-and-tricks.md
│ └── usage.md
├── docs_theme/
│ ├── assets/
│ │ ├── colors.css
│ │ ├── highlight.css
│ │ ├── index.css
│ │ └── theme.css
│ ├── breadcrumbs.html
│ ├── index.html
│ ├── index.js
│ ├── main.html
│ ├── requirements.txt
│ └── search.html
├── issue_template.md
├── jrnl/
│ ├── __init__.py
│ ├── __main__.py
│ ├── __version__.py
│ ├── args.py
│ ├── color.py
│ ├── commands.py
│ ├── config.py
│ ├── controller.py
│ ├── editor.py
│ ├── encryption/
│ │ ├── BaseEncryption.py
│ │ ├── BaseKeyEncryption.py
│ │ ├── BasePasswordEncryption.py
│ │ ├── Jrnlv1Encryption.py
│ │ ├── Jrnlv2Encryption.py
│ │ ├── NoEncryption.py
│ │ └── __init__.py
│ ├── exception.py
│ ├── install.py
│ ├── journals/
│ │ ├── DayOneJournal.py
│ │ ├── Entry.py
│ │ ├── FolderJournal.py
│ │ ├── Journal.py
│ │ └── __init__.py
│ ├── keyring.py
│ ├── main.py
│ ├── messages/
│ │ ├── Message.py
│ │ ├── MsgStyle.py
│ │ ├── MsgText.py
│ │ └── __init__.py
│ ├── os_compat.py
│ ├── output.py
│ ├── override.py
│ ├── path.py
│ ├── plugins/
│ │ ├── __init__.py
│ │ ├── calendar_heatmap_exporter.py
│ │ ├── dates_exporter.py
│ │ ├── fancy_exporter.py
│ │ ├── jrnl_importer.py
│ │ ├── json_exporter.py
│ │ ├── markdown_exporter.py
│ │ ├── tag_exporter.py
│ │ ├── text_exporter.py
│ │ ├── util.py
│ │ ├── xml_exporter.py
│ │ └── yaml_exporter.py
│ ├── prompt.py
│ ├── templates/
│ │ └── sample.template
│ ├── time.py
│ └── upgrade.py
├── mkdocs.yml
├── package.json
├── pyproject.toml
├── tasks.py
└── tests/
├── __init__.py
├── bdd/
│ ├── features/
│ │ ├── actions.feature
│ │ ├── build.feature
│ │ ├── change_time.feature
│ │ ├── config_file.feature
│ │ ├── core.feature
│ │ ├── datetime.feature
│ │ ├── delete.feature
│ │ ├── encrypt.feature
│ │ ├── file_storage.feature
│ │ ├── format.feature
│ │ ├── import.feature
│ │ ├── install.feature
│ │ ├── multiple_journals.feature
│ │ ├── override.feature
│ │ ├── password.feature
│ │ ├── search.feature
│ │ ├── star.feature
│ │ ├── tag.feature
│ │ ├── template.feature
│ │ ├── upgrade.feature
│ │ └── write.feature
│ └── test_features.py
├── conftest.py
├── data/
│ ├── configs/
│ │ ├── basic_dayone.yaml
│ │ ├── basic_encrypted.yaml
│ │ ├── basic_folder.yaml
│ │ ├── basic_onefile.yaml
│ │ ├── brackets.yaml
│ │ ├── bug153.yaml
│ │ ├── bug780.yaml
│ │ ├── dayone.yaml
│ │ ├── dayone_empty.yaml
│ │ ├── deletion.yaml
│ │ ├── deletion_filters.yaml
│ │ ├── duplicate_keys.yaml
│ │ ├── editor-args.yaml
│ │ ├── editor.yaml
│ │ ├── editor_empty_folder.yaml
│ │ ├── editor_encrypted.yaml
│ │ ├── editor_markdown_extension.yaml
│ │ ├── empty_file.yaml
│ │ ├── empty_folder.yaml
│ │ ├── encrypted.yaml
│ │ ├── encrypted_old.json
│ │ ├── encrypted_old.yaml
│ │ ├── format_md.yaml
│ │ ├── format_text.yaml
│ │ ├── invalid_color.yaml
│ │ ├── linewrap_auto.yaml
│ │ ├── little_endian_dates.yaml
│ │ ├── markdown-headings-335.yaml
│ │ ├── missing_directory.yaml
│ │ ├── missing_journal.yaml
│ │ ├── mostlyreadabledates.yaml
│ │ ├── multiline-tags.yaml
│ │ ├── multiline.yaml
│ │ ├── multiple.yaml
│ │ ├── no_colors.yaml
│ │ ├── no_default_journal.yaml
│ │ ├── simple.yaml
│ │ ├── tags-216.yaml
│ │ ├── tags-237.yaml
│ │ ├── tags.yaml
│ │ ├── unreadabledates.yaml
│ │ ├── upgrade_from_195.json
│ │ ├── upgrade_from_195_little_endian_dates.json
│ │ ├── upgrade_from_195_with_missing_encrypted_journal.json
│ │ └── upgrade_from_195_with_missing_journal.json
│ ├── journals/
│ │ ├── basic_dayone.dayone/
│ │ │ └── entries/
│ │ │ ├── D04D335AFED711EABA18FAFFC2100C3D.doentry
│ │ │ ├── FC8A86CAFED711EA8892FAFFC2100C3D.doentry
│ │ │ └── FD8ABC8EFED711EABC35FAFFC2100C3D.doentry
│ │ ├── basic_encrypted.journal
│ │ ├── basic_folder/
│ │ │ ├── 2020/
│ │ │ │ ├── 08/
│ │ │ │ │ ├── 29.txt
│ │ │ │ │ └── 31.txt
│ │ │ │ ├── 09/
│ │ │ │ │ ├── 24.txt
│ │ │ │ │ └── should-be-ignored.txt
│ │ │ │ └── should-be-ignored.txt
│ │ │ └── should-be-ignored.txt
│ │ ├── basic_onefile.journal
│ │ ├── brackets.journal
│ │ ├── bug153.dayone/
│ │ │ └── entries/
│ │ │ ├── B40EE704E15846DE8D45C44118A4D511.doentry
│ │ │ └── B40EE704E15846DE8D45C44118A4D512.doentry
│ │ ├── bug780.dayone/
│ │ │ └── entries/
│ │ │ └── 48A25033B34047C591160A4480197D8B.doentry
│ │ ├── dayone.dayone/
│ │ │ └── entries/
│ │ │ ├── 044F3747A38546168B572C2E3F217FA2.doentry
│ │ │ ├── 0BDDD6CDA43C4A9AA2681517CC35AD9D.doentry
│ │ │ ├── 422BC895507944A291E6FC44FC6B8BFC.doentry
│ │ │ └── 4BB1F46946AD439996C9B59DE7C4DDC1.doentry
│ │ ├── dayone_empty.dayone/
│ │ │ └── entries/
│ │ │ └── empty.txt
│ │ ├── deletion.journal
│ │ ├── deletion_filters.journal
│ │ ├── empty_folder/
│ │ │ └── empty
│ │ ├── encrypted.journal
│ │ ├── encrypted_jrnl-1-9-5.journal
│ │ ├── little_endian_dates.journal
│ │ ├── markdown-headings-335.journal
│ │ ├── mostlyreadabledates.journal
│ │ ├── multiline-tags.journal
│ │ ├── multiline.journal
│ │ ├── simple.journal
│ │ ├── simple_jrnl-1-9-5.journal
│ │ ├── simple_jrnl-1-9-5_little_endian_dates.journal
│ │ ├── tags-216.journal
│ │ ├── tags-237.journal
│ │ ├── tags.journal
│ │ ├── unreadabledates.journal
│ │ └── work.journal
│ └── templates/
│ ├── basic.template
│ └── sample.template
├── lib/
│ ├── fixtures.py
│ ├── given_steps.py
│ ├── helpers.py
│ ├── then_steps.py
│ ├── type_builders.py
│ └── when_steps.py
└── unit/
├── test_color.py
├── test_config_file.py
├── test_controller.py
├── test_editor.py
├── test_export.py
├── test_install.py
├── test_journals_folder_journal.py
├── test_os_compat.py
├── test_output.py
├── test_override.py
├── test_parse_args.py
├── test_path.py
└── test_time.py
SYMBOL INDEX (478 symbols across 63 files)
FILE: jrnl/args.py
class WrappingFormatter (line 20) | class WrappingFormatter(argparse.RawTextHelpFormatter):
method _split_lines (line 23) | def _split_lines(self, text: str, width: int) -> list[str]:
class IgnoreNoneAppendAction (line 31) | class IgnoreNoneAppendAction(argparse._AppendAction):
method __call__ (line 37) | def __call__(self, parser, namespace, values, option_string=None):
function parse_not_arg (line 42) | def parse_not_arg(
function parse_args (line 68) | def parse_args(args: list[str] = []) -> argparse.Namespace:
FILE: jrnl/color.py
function colorize (line 20) | def colorize(string: str, color: str, bold: bool = False) -> str:
function highlight_tags_with_background_color (line 33) | def highlight_tags_with_background_color(
FILE: jrnl/commands.py
function preconfig_diagnostic (line 31) | def preconfig_diagnostic(_) -> None:
function preconfig_version (line 42) | def preconfig_version(_) -> None:
function postconfig_list (line 62) | def postconfig_list(args: argparse.Namespace, config: dict, **_) -> int:
function postconfig_import (line 71) | def postconfig_import(args: argparse.Namespace, config: dict, **_) -> int:
function postconfig_encrypt (line 95) | def postconfig_encrypt(
function postconfig_decrypt (line 152) | def postconfig_decrypt(
FILE: jrnl/config.py
function make_yaml_valid_dict (line 32) | def make_yaml_valid_dict(input: list) -> dict:
function save_config (line 57) | def save_config(config: dict, alt_config_path: str | None = None) -> None:
function get_default_config (line 72) | def get_default_config() -> dict[str, Any]:
function get_default_colors (line 95) | def get_default_colors() -> dict[str, Any]:
function scope_config (line 104) | def scope_config(config: dict, journal_name: str) -> dict:
function verify_config_colors (line 124) | def verify_config_colors(config: dict) -> bool:
function load_config (line 149) | def load_config(config_path: str) -> dict:
function is_config_json (line 172) | def is_config_json(config_path: str) -> bool:
function update_config (line 178) | def update_config(
function get_journal_name (line 193) | def get_journal_name(args: argparse.Namespace, config: dict) -> argparse...
function cmd_requires_valid_journal_name (line 210) | def cmd_requires_valid_journal_name(func: Callable) -> Callable:
function validate_journal_name (line 218) | def validate_journal_name(journal_name: str, config: dict) -> None:
FILE: jrnl/controller.py
function run (line 34) | def run(args: "Namespace"):
function _perform_actions_on_search_results (line 97) | def _perform_actions_on_search_results(**kwargs):
function _is_append_mode (line 112) | def _is_append_mode(args: "Namespace", config: dict, **kwargs) -> bool:
function append_mode (line 132) | def append_mode(args: "Namespace", config: dict, journal: "Journal", **k...
function _get_template (line 181) | def _get_template(args, config) -> str:
function search_mode (line 198) | def search_mode(args: "Namespace", journal: "Journal", **kwargs) -> None:
function _write_in_editor (line 214) | def _write_in_editor(config: dict, prepopulated_text: str | None = None)...
function _filter_journal_entries (line 224) | def _filter_journal_entries(args: "Namespace", journal: "Journal", **kwa...
function _print_entries_found_count (line 252) | def _print_entries_found_count(count: int, args: "Namespace") -> None:
function _other_entries (line 274) | def _other_entries(journal: "Journal", entries: list["Entry"]) -> list["...
function _edit_search_results (line 279) | def _edit_search_results(
function _print_changed_counts (line 318) | def _print_changed_counts(journal: "Journal", **kwargs) -> None:
function _get_predit_stats (line 352) | def _get_predit_stats(journal: "Journal") -> dict[str, int]:
function _delete_search_results (line 356) | def _delete_search_results(
function _change_time_search_results (line 369) | def _change_time_search_results(
function _display_search_results (line 388) | def _display_search_results(args: "Namespace", journal: "Journal", **kwa...
function _has_search_args (line 411) | def _has_search_args(args: "Namespace") -> bool:
function _has_action_args (line 434) | def _has_action_args(args: "Namespace") -> bool:
function _has_display_args (line 444) | def _has_display_args(args: "Namespace") -> bool:
function _has_only_tags (line 454) | def _has_only_tags(tag_symbols: str, args_text: str) -> bool:
FILE: jrnl/editor.py
function get_text_from_editor (line 22) | def get_text_from_editor(config: dict, template: str = "") -> str:
function get_text_from_stdin (line 55) | def get_text_from_stdin() -> str:
function get_template_path (line 80) | def get_template_path(template_path: str, jrnl_template_dir: str) -> str:
function read_template_file (line 92) | def read_template_file(template_path: str) -> str:
FILE: jrnl/encryption/BaseEncryption.py
class BaseEncryption (line 14) | class BaseEncryption(ABC):
method __init__ (line 15) | def __init__(self, journal_name: str, config: dict):
method clear (line 21) | def clear(self) -> None:
method encrypt (line 24) | def encrypt(self, text: str) -> bytes:
method decrypt (line 28) | def decrypt(self, text: bytes) -> str:
method _encrypt (line 38) | def _encrypt(self, text: str) -> bytes:
method _decrypt (line 47) | def _decrypt(self, text: bytes) -> str | None:
FILE: jrnl/encryption/BaseKeyEncryption.py
class BaseKeyEncryption (line 7) | class BaseKeyEncryption(BaseEncryption):
FILE: jrnl/encryption/BasePasswordEncryption.py
class BasePasswordEncryption (line 16) | class BasePasswordEncryption(BaseEncryption):
method __init__ (line 17) | def __init__(self, *args, **kwargs) -> None:
method check_keyring (line 26) | def check_keyring(self) -> bool:
method check_keyring (line 30) | def check_keyring(self, value: bool) -> None:
method password (line 34) | def password(self) -> str | None:
method password (line 38) | def password(self, value: str) -> None:
method clear (line 41) | def clear(self):
method encrypt (line 45) | def encrypt(self, text: str) -> bytes:
method decrypt (line 58) | def decrypt(self, text: bytes) -> str:
method _prompt_password (line 74) | def _prompt_password(self) -> None:
FILE: jrnl/encryption/Jrnlv1Encryption.py
class Jrnlv1Encryption (line 16) | class Jrnlv1Encryption(BasePasswordEncryption):
method __init__ (line 17) | def __init__(self, *args, **kwargs) -> None:
method _encrypt (line 21) | def _encrypt(self, _: str) -> bytes:
method _decrypt (line 24) | def _decrypt(self, text: bytes) -> str | None:
FILE: jrnl/encryption/Jrnlv2Encryption.py
class Jrnlv2Encryption (line 16) | class Jrnlv2Encryption(BasePasswordEncryption):
method __init__ (line 17) | def __init__(self, *args, **kwargs) -> None:
method password (line 26) | def password(self):
method password (line 30) | def password(self, value: str | None):
method _make_key (line 34) | def _make_key(self) -> None:
method _encrypt (line 50) | def _encrypt(self, text: str) -> bytes:
method _decrypt (line 54) | def _decrypt(self, text: bytes) -> str | None:
FILE: jrnl/encryption/NoEncryption.py
class NoEncryption (line 9) | class NoEncryption(BaseEncryption):
method __init__ (line 10) | def __init__(self, *args, **kwargs):
method _encrypt (line 14) | def _encrypt(self, text: str) -> bytes:
method _decrypt (line 18) | def _decrypt(self, text: bytes) -> str:
FILE: jrnl/encryption/__init__.py
class EncryptionMethods (line 13) | class EncryptionMethods(str, Enum):
method __str__ (line 14) | def __str__(self) -> str:
function determine_encryption_method (line 22) | def determine_encryption_method(config: str | bool) -> Type["BaseEncrypt...
FILE: jrnl/exception.py
class JrnlException (line 13) | class JrnlException(Exception):
method __init__ (line 16) | def __init__(self, *messages: "Message"):
method print (line 19) | def print(self) -> None:
method has_message_text (line 23) | def has_message_text(self, message_text: "MsgText"):
FILE: jrnl/install.py
function upgrade_config (line 33) | def upgrade_config(config_data: dict, alt_config_path: str | None = None...
function find_default_config (line 60) | def find_default_config() -> str:
function find_alt_config (line 69) | def find_alt_config(alt_config: str) -> str:
function load_or_install_jrnl (line 80) | def load_or_install_jrnl(alt_config_path: str) -> dict:
function install (line 121) | def install() -> dict:
function _initialize_autocomplete (line 169) | def _initialize_autocomplete() -> None:
function _autocomplete_path (line 179) | def _autocomplete_path(text: str, state: int) -> list[str | None]:
FILE: jrnl/journals/DayOneJournal.py
class DayOne (line 27) | class DayOne(Journal):
method __init__ (line 37) | def __init__(self, **kwargs):
method open (line 43) | def open(self) -> "DayOne":
method write (line 103) | def write(self) -> None:
method editable_str (line 167) | def editable_str(self) -> str:
method _update_old_entry (line 172) | def _update_old_entry(self, entry: Entry, new_entry: Entry) -> None:
method _get_and_remove_uuid_from_entry (line 180) | def _get_and_remove_uuid_from_entry(self, entry: Entry) -> Entry:
method parse_editable_str (line 191) | def parse_editable_str(self, edited: str) -> None:
FILE: jrnl/journals/Entry.py
class Entry (line 18) | class Entry:
method __init__ (line 19) | def __init__(
method fulltext (line 36) | def fulltext(self) -> str:
method _parse_text (line 39) | def _parse_text(self):
method title (line 50) | def title(self) -> str:
method title (line 56) | def title(self, x: str):
method body (line 60) | def body(self) -> str:
method body (line 66) | def body(self, x: str):
method tags (line 70) | def tags(self) -> list[str]:
method tags (line 76) | def tags(self, x: list[str]):
method tag_regex (line 80) | def tag_regex(tagsymbols: str) -> re.Pattern:
method _parse_tags (line 84) | def _parse_tags(self) -> set[str]:
method __str__ (line 90) | def __str__(self):
method pprint (line 102) | def pprint(self, short: bool = False) -> str:
method __repr__ (line 183) | def __repr__(self):
method __hash__ (line 188) | def __hash__(self):
method __eq__ (line 191) | def __eq__(self, other: "Entry"):
method __ne__ (line 202) | def __ne__(self, other: "Entry"):
function split_title (line 224) | def split_title(text: str) -> tuple[str, str]:
FILE: jrnl/journals/FolderJournal.py
class Folder (line 23) | class Folder(Journal):
method __init__ (line 26) | def __init__(self, name: str = "default", **kwargs):
method open (line 32) | def open(self) -> "Folder":
method write (line 46) | def write(self) -> None:
method delete_entries (line 89) | def delete_entries(self, entries_to_delete: list["Entry"]) -> None:
method change_date_entries (line 96) | def change_date_entries(self, date: str, entries_to_change: list["Entr...
method parse_editable_str (line 108) | def parse_editable_str(self, edited: str) -> None:
method _get_files (line 124) | def _get_files(journal_path: str) -> list[str]:
method _get_year_folders (line 132) | def _get_year_folders(path: pathlib.Path) -> list[pathlib.Path]:
method _get_month_folders (line 139) | def _get_month_folders(path: pathlib.Path) -> list[pathlib.Path]:
method _get_day_files (line 146) | def _get_day_files(path: pathlib.Path) -> list[str]:
FILE: jrnl/journals/Journal.py
class Tag (line 22) | class Tag:
method __init__ (line 23) | def __init__(self, name, count=0):
method __str__ (line 27) | def __str__(self):
method __repr__ (line 30) | def __repr__(self):
class Journal (line 34) | class Journal:
method __init__ (line 35) | def __init__(self, name="default", **kwargs):
method __len__ (line 58) | def __len__(self):
method __iter__ (line 62) | def __iter__(self):
method from_journal (line 67) | def from_journal(cls, other: "Journal") -> "Journal":
method import_ (line 80) | def import_(self, other_journal_txt: str) -> None:
method _get_encryption_method (line 88) | def _get_encryption_method(self) -> None:
method _decrypt (line 92) | def _decrypt(self, text: bytes) -> str:
method _encrypt (line 98) | def _encrypt(self, text: str) -> bytes:
method open (line 104) | def open(self, filename: str | None = None) -> "Journal":
method write (line 139) | def write(self, filename: str | None = None) -> None:
method validate_parsing (line 146) | def validate_parsing(self) -> bool:
method create_file (line 152) | def create_file(filename: str) -> None:
method _to_text (line 156) | def _to_text(self) -> str:
method _load (line 159) | def _load(self, filename: str) -> bytes:
method _store (line 163) | def _store(self, filename: str, text: bytes) -> None:
method _parse (line 167) | def _parse(self, journal_txt: str) -> list[Entry]:
method pprint (line 206) | def pprint(self, short: bool = False) -> str:
method __str__ (line 210) | def __str__(self):
method __repr__ (line 213) | def __repr__(self):
method sort (line 216) | def sort(self) -> None:
method limit (line 220) | def limit(self, n: int | None = None) -> None:
method tags (line 226) | def tags(self) -> list[Tag]:
method filter (line 236) | def filter(
method delete_entries (line 321) | def delete_entries(self, entries_to_delete: list[Entry]) -> None:
method change_date_entries (line 327) | def change_date_entries(
method prompt_action_entries (line 337) | def prompt_action_entries(self, msg: MsgText) -> list[Entry]:
method new_entry (line 357) | def new_entry(self, raw: str, date=None, sort: bool = True) -> Entry:
method editable_str (line 395) | def editable_str(self) -> str:
method parse_editable_str (line 400) | def parse_editable_str(self, edited: str) -> None:
method increment_change_counts_by_edit (line 413) | def increment_change_counts_by_edit(self, mod_entries: Entry) -> None:
method get_change_counts (line 419) | def get_change_counts(self) -> dict:
class LegacyJournal (line 427) | class LegacyJournal(Journal):
method _parse (line 432) | def _parse(self, journal_txt: str) -> list[Entry]:
function open_journal (line 479) | def open_journal(journal_name: str, config: dict, legacy: bool = False) ...
FILE: jrnl/keyring.py
function get_keyring_password (line 12) | def get_keyring_password(journal_name: str = "default") -> str | None:
function set_keyring_password (line 21) | def set_keyring_password(password: str, journal_name: str = "default") -...
FILE: jrnl/main.py
function configure_logger (line 19) | def configure_logger(debug: bool = False) -> None:
function run (line 35) | def run(manual_args: list[str] | None = None) -> int:
FILE: jrnl/messages/Message.py
class Message (line 14) | class Message(NamedTuple):
FILE: jrnl/messages/MsgStyle.py
class MsgStyle (line 14) | class MsgStyle(Enum):
class _Color (line 15) | class _Color(NamedTuple):
class _Decoration (line 23) | class _Decoration(Enum):
method callback (line 39) | def callback(self) -> Callable:
method args (line 43) | def args(self) -> dict:
method decoration (line 76) | def decoration(self) -> _Decoration:
method color (line 80) | def color(self) -> _Color:
method prepend_newline (line 84) | def prepend_newline(self) -> bool:
method append_space (line 88) | def append_space(self) -> bool:
method box_title (line 92) | def box_title(self) -> MsgText:
FILE: jrnl/messages/MsgText.py
class MsgText (line 7) | class MsgText(Enum):
method __str__ (line 8) | def __str__(self) -> str:
FILE: jrnl/os_compat.py
function on_windows (line 8) | def on_windows() -> bool:
function on_posix (line 12) | def on_posix() -> bool:
function split_args (line 16) | def split_args(args: str) -> list[str]:
FILE: jrnl/output.py
function deprecated_cmd (line 15) | def deprecated_cmd(
function journal_list_to_json (line 30) | def journal_list_to_json(journal_list: dict) -> str:
function journal_list_to_yaml (line 36) | def journal_list_to_yaml(journal_list: dict) -> str:
function journal_list_to_stdout (line 49) | def journal_list_to_stdout(journal_list: dict) -> str:
function list_journals (line 59) | def list_journals(configuration: dict, format: str | None = None) -> str:
function print_msg (line 77) | def print_msg(msg: Message, **kwargs) -> str | None:
function print_msgs (line 83) | def print_msgs(
function _get_console (line 117) | def _get_console(stderr: bool = True) -> Console:
function _add_extra_style_args_if_needed (line 121) | def _add_extra_style_args_if_needed(args: dict, msg: Message):
function format_msg_text (line 127) | def format_msg_text(msg: Message) -> Text:
function wrap_with_ansi_colors (line 136) | def wrap_with_ansi_colors(text: str, width: int) -> str:
FILE: jrnl/override.py
function apply_overrides (line 14) | def apply_overrides(args: "Namespace", base_config: dict) -> dict:
function _get_key_and_value_from_pair (line 41) | def _get_key_and_value_from_pair(pairs: dict) -> tuple:
function _convert_dots_to_list (line 46) | def _convert_dots_to_list(key_as_dots: str) -> list[str]:
function _recursively_apply (line 52) | def _recursively_apply(tree: dict, nodes: list, override_value) -> dict:
function _get_config_node (line 74) | def _get_config_node(config: dict, key: str):
FILE: jrnl/path.py
function home_dir (line 20) | def home_dir() -> str:
function expand_path (line 24) | def expand_path(path: str) -> str:
function absolute_path (line 28) | def absolute_path(path: str) -> str:
function get_default_journal_path (line 32) | def get_default_journal_path() -> str:
function get_templates_path (line 37) | def get_templates_path() -> str:
function get_config_directory (line 50) | def get_config_directory() -> str:
function get_config_path (line 67) | def get_config_path() -> str:
FILE: jrnl/plugins/__init__.py
function get_exporter (line 39) | def get_exporter(format: str) -> Type[TextExporter] | None:
function get_importer (line 46) | def get_importer(format: str) -> Type[JRNLImporter] | None:
FILE: jrnl/plugins/calendar_heatmap_exporter.py
class CalendarHeatmapExporter (line 24) | class CalendarHeatmapExporter(TextExporter):
method export_entry (line 31) | def export_entry(cls, entry: "Entry"):
method print_calendar_heatmap (line 35) | def print_calendar_heatmap(cls, journal_frequency: "NestedDict") -> str:
method export_journal (line 114) | def export_journal(cls, journal: "Journal"):
FILE: jrnl/plugins/dates_exporter.py
class DatesExporter (line 14) | class DatesExporter(TextExporter):
method export_entry (line 21) | def export_entry(cls, entry: "Entry"):
method export_journal (line 25) | def export_journal(cls, journal: "Journal") -> str:
FILE: jrnl/plugins/fancy_exporter.py
class FancyExporter (line 20) | class FancyExporter(TextExporter):
method export_entry (line 43) | def export_entry(cls, entry: "Entry") -> str:
method export_journal (line 103) | def export_journal(cls, journal) -> str:
function check_provided_linewrap_viability (line 108) | def check_provided_linewrap_viability(
FILE: jrnl/plugins/jrnl_importer.py
class JRNLImporter (line 17) | class JRNLImporter:
method import_ (line 23) | def import_(journal: "Journal", input: str | None = None) -> None:
FILE: jrnl/plugins/json_exporter.py
class JSONExporter (line 15) | class JSONExporter(TextExporter):
method entry_to_dict (line 22) | def entry_to_dict(cls, entry: "Entry") -> dict:
method export_entry (line 57) | def export_entry(cls, entry: "Entry") -> str:
method export_journal (line 62) | def export_journal(cls, journal: "Journal") -> str:
FILE: jrnl/plugins/markdown_exporter.py
class MarkdownExporter (line 19) | class MarkdownExporter(TextExporter):
method export_entry (line 26) | def export_entry(cls, entry: "Entry", to_multifile: bool = True) -> str:
method export_journal (line 81) | def export_journal(cls, journal: "Journal") -> str:
FILE: jrnl/plugins/tag_exporter.py
class TagExporter (line 14) | class TagExporter(TextExporter):
method export_entry (line 21) | def export_entry(cls, entry: "Entry") -> str:
method export_journal (line 26) | def export_journal(cls, journal: "Journal") -> str:
FILE: jrnl/plugins/text_exporter.py
class TextExporter (line 20) | class TextExporter:
method export_entry (line 27) | def export_entry(cls, entry: "Entry") -> str:
method export_journal (line 32) | def export_journal(cls, journal: "Journal") -> str:
method write_file (line 37) | def write_file(cls, journal: "Journal", path: str) -> str:
method make_filename (line 54) | def make_filename(cls, entry: "Entry") -> str:
method write_files (line 60) | def write_files(cls, journal: "Journal", path: str) -> str:
method _slugify (line 90) | def _slugify(string: str) -> str:
method export (line 100) | def export(cls, journal: "Journal", output: str | None = None) -> str:
FILE: jrnl/plugins/util.py
class NestedDict (line 11) | class NestedDict(dict):
method __missing__ (line 14) | def __missing__(self, x):
function get_tags_count (line 19) | def get_tags_count(journal: "Journal") -> set[tuple[int, str]]:
function oxford_list (line 30) | def oxford_list(lst: list) -> str:
function get_journal_frequency_nested (line 43) | def get_journal_frequency_nested(journal: "Journal") -> NestedDict:
function get_journal_frequency_one_level (line 56) | def get_journal_frequency_one_level(journal: "Journal") -> Counter:
FILE: jrnl/plugins/xml_exporter.py
class XMLExporter (line 15) | class XMLExporter(JSONExporter):
method export_entry (line 22) | def export_entry(
method entry_to_xml (line 39) | def entry_to_xml(cls, entry: "Entry", doc: minidom.Document) -> minido...
method export_journal (line 54) | def export_journal(cls, journal: "Journal") -> str:
FILE: jrnl/plugins/yaml_exporter.py
class YAMLExporter (line 20) | class YAMLExporter(TextExporter):
method export_entry (line 28) | def export_entry(cls, entry: "Entry", to_multifile: bool = True) -> str:
method export_journal (line 140) | def export_journal(cls, journal: "Journal"):
FILE: jrnl/prompt.py
function create_password (line 11) | def create_password(journal_name: str) -> str:
function prompt_password (line 45) | def prompt_password(first_try: bool = True) -> str:
function yesno (line 59) | def yesno(prompt: Message | str, default: bool = True) -> bool:
FILE: jrnl/time.py
function __get_pdt_calendar (line 11) | def __get_pdt_calendar():
function parse (line 21) | def parse(
function is_valid_date (line 98) | def is_valid_date(year: int, month: int, day: int) -> bool:
FILE: jrnl/upgrade.py
function backup (line 23) | def backup(filename: str, binary: bool = False):
function check_exists (line 46) | def check_exists(path: str) -> bool:
function upgrade_jrnl (line 53) | def upgrade_jrnl(config_path: str) -> None:
function is_old_version (line 192) | def is_old_version(config_path: str) -> bool:
function _print_journal_summary (line 196) | def _print_journal_summary(journals: dict, header: Message, pad: int) ->...
FILE: tasks.py
function delete_files (line 17) | def delete_files(files):
function run_shell (line 22) | def run_shell(command):
function generate_sitemap (line 27) | def generate_sitemap():
function generate_pa11y_config_from_sitemap (line 33) | def generate_pa11y_config_from_sitemap():
function output_file (line 54) | def output_file(file):
FILE: tests/conftest.py
function pytest_bdd_apply_tag (line 18) | def pytest_bdd_apply_tag(tag, function):
function pytest_runtest_setup (line 38) | def pytest_runtest_setup(item):
FILE: tests/lib/fixtures.py
function keyring (line 25) | def keyring():
function keyring_type (line 30) | def keyring_type():
class TestKeyring (line 34) | class TestKeyring(backend.KeyringBackend):
method set_password (line 40) | def set_password(self, servicename, username, password):
method get_password (line 43) | def get_password(self, servicename, username):
method delete_password (line 46) | def delete_password(self, servicename, username):
class NoKeyring (line 50) | class NoKeyring(backend.KeyringBackend):
method set_password (line 56) | def set_password(self, servicename, username, password):
method get_password (line 59) | def get_password(self, servicename, username):
method delete_password (line 62) | def delete_password(self, servicename, username):
class FailedKeyring (line 66) | class FailedKeyring(backend.KeyringBackend):
method set_password (line 71) | def set_password(self, servicename, username, password):
method get_password (line 74) | def get_password(self, servicename, username):
method delete_password (line 77) | def delete_password(self, servicename, username):
function cli_run (line 83) | def cli_run(
function mock_factories (line 114) | def mock_factories():
function mock_args (line 119) | def mock_args(cache_dir, request):
function mock_is_tty (line 134) | def mock_is_tty(is_tty):
function mock_overrides (line 139) | def mock_overrides(config_in_memory):
function mock_config_path (line 155) | def mock_config_path(request):
function mock_default_journal_path (line 172) | def mock_default_journal_path(temp_dir):
function mock_default_templates_path (line 185) | def mock_default_templates_path(temp_dir):
function temp_dir (line 195) | def temp_dir():
function working_dir (line 200) | def working_dir(request):
function toml_version (line 205) | def toml_version(working_dir):
function input_method (line 220) | def input_method():
function all_input (line 225) | def all_input():
function command (line 230) | def command():
function cache_dir (line 235) | def cache_dir():
function str_value (line 240) | def str_value():
function should_not (line 245) | def should_not():
function mock_user_input (line 250) | def mock_user_input(request, password_input, stdin_input):
function password_input (line 285) | def password_input(request):
function stdin_input (line 293) | def stdin_input(request, is_tty):
function is_tty (line 303) | def is_tty(input_method):
function config_on_disk (line 309) | def config_on_disk(config_path):
function config_in_memory (line 314) | def config_in_memory():
function journal_name (line 319) | def journal_name():
function which_output_stream (line 324) | def which_output_stream():
function editor_input (line 329) | def editor_input():
function num_args (line 334) | def num_args():
function parsed_output (line 339) | def parsed_output():
function editor_state (line 344) | def editor_state():
function mock_editor (line 353) | def mock_editor(editor_state):
FILE: tests/lib/given_steps.py
function we_enter_editor_docstring (line 26) | def we_enter_editor_docstring(editor_method, editor_state, docstring):
function we_enter_editor (line 31) | def we_enter_editor(editor_method, editor_input, editor_state):
function now_is_str (line 44) | def now_is_str(date_str, mock_factories):
function we_dont_have_keyring (line 76) | def we_dont_have_keyring(keyring_type):
function we_have_type_of_keyring (line 82) | def we_have_type_of_keyring(keyring_type):
function we_use_no_config (line 92) | def we_use_no_config(temp_dir):
function we_use_the_config (line 98) | def we_use_the_config(request, temp_dir, working_dir, config_file):
function we_copy_the_template (line 137) | def we_copy_the_template(request, temp_dir, working_dir, template_file):
function config_exists (line 150) | def config_exists(config_file, temp_dir, working_dir):
function use_password_forever (line 157) | def use_password_forever(password):
function create_cache_dir (line 162) | def create_cache_dir(temp_dir):
function parse_output_as_language (line 171) | def parse_output_as_language(cli_run, language_name):
function home_directory (line 186) | def home_directory(temp_dir, home_dir, monkeypatch):
FILE: tests/lib/helpers.py
function does_directory_contain_files (line 8) | def does_directory_contain_files(file_list, directory_path):
function does_directory_contain_n_files (line 20) | def does_directory_contain_n_files(directory_path, number):
function assert_equal_tags_ignoring_order (line 35) | def assert_equal_tags_ignoring_order(
function get_nested_val (line 49) | def get_nested_val(dictionary, path, *default):
function spy_wrapper (line 59) | def spy_wrapper(wrapped_function):
function get_fixture (line 72) | def get_fixture(request, name, default=None):
FILE: tests/lib/then_steps.py
function should_get_no_error (line 25) | def should_get_no_error(cli_run):
function should_get_an_error (line 30) | def should_get_an_error(cli_run):
function output_should_match_docstring (line 35) | def output_should_match_docstring(cli_run, docstring):
function output_should_match (line 40) | def output_should_match(regex, cli_run):
function output_should_contain_docstring (line 53) | def output_should_contain_docstring(which_output_stream, cli_run, it_sho...
function output_should_contain (line 64) | def output_should_contain(expected, which_output_stream, cli_run, it_sho...
function output_should_not_contain_docstring (line 88) | def output_should_not_contain_docstring(cli_run, docstring):
function output_should_not_contain (line 93) | def output_should_not_contain(expected_output, cli_run):
function output_should_be_docstring (line 98) | def output_should_be_docstring(cli_run, docstring):
function output_should_be (line 103) | def output_should_be(expected_output, cli_run):
function output_should_be_empty (line 110) | def output_should_be_empty(cli_run):
function output_should_contain_date (line 116) | def output_should_contain_date(date, cli_run):
function output_should_contain_version (line 121) | def output_should_contain_version(cli_run, toml_version):
function config_file_version (line 127) | def config_file_version(config_on_disk, toml_version):
function output_should_be_columns_wide (line 133) | def output_should_be_columns_wide(cli_run, width):
function default_journal_location (line 146) | def default_journal_location(journal_file, journal_dir, config_on_disk, ...
function config_var_on_disk_docstring (line 164) | def config_var_on_disk_docstring(config_on_disk, journal_name, it_should...
function config_var_on_disk (line 176) | def config_var_on_disk(config_on_disk, journal_name, it_should, some_yaml):
function config_var_in_memory_docstring (line 199) | def config_var_in_memory_docstring(
function config_var_in_memory (line 215) | def config_var_in_memory(config_in_memory, journal_name, it_should, some...
function password_was_called (line 231) | def password_was_called(cli_run):
function password_was_not_called (line 236) | def password_was_not_called(cli_run):
function assert_dir_contains_files (line 241) | def assert_dir_contains_files(cache_dir, docstring):
function assert_dir_contains_n_files (line 248) | def assert_dir_contains_n_files(cache_dir, number):
function journal_directory_should_contain (line 253) | def journal_directory_should_contain(config_on_disk, docstring):
function journal_directory_should_not_exist (line 260) | def journal_directory_should_not_exist(config_on_disk, journal_name):
function journal_should_not_exist (line 269) | def journal_should_not_exist(config_on_disk, it_should):
function directory_should_not_exist (line 283) | def directory_should_not_exist(config_on_disk, it_should, journal_name):
function content_of_file_should_be (line 292) | def content_of_file_should_be(file_path, cache_dir, docstring):
function cache_dir_contains_files (line 312) | def cache_dir_contains_files(cache_dir, docstring):
function assert_output_is_valid_language (line 326) | def assert_output_is_valid_language(cli_run, language_name):
function assert_parsed_output_item_count (line 338) | def assert_parsed_output_item_count(node_name, number, parsed_output):
function assert_output_field_content (line 366) | def assert_output_field_content(field_name, comparison, parsed_output, d...
function count_elements (line 417) | def count_elements(number, item, cli_run):
function count_editor_args (line 430) | def count_editor_args(num_args, cli_run, editor_state, it_should):
function stdin_prompt_called (line 438) | def stdin_prompt_called(cli_run, it_should):
function editor_filename_suffix (line 443) | def editor_filename_suffix(suffix, editor_state):
function contains_editor_file_docstring (line 450) | def contains_editor_file_docstring(comparison, editor_state, docstring):
function contains_editor_file (line 456) | def contains_editor_file(comparison, str_value, editor_state):
FILE: tests/lib/when_steps.py
function when_we_change_directory (line 22) | def when_we_change_directory(directory_name):
function we_run_jrnl_docstring (line 38) | def we_run_jrnl_docstring(capsys, keyring, request, command, input_metho...
function we_run_jrnl (line 45) | def we_run_jrnl(capsys, keyring, request, command, input_method, all_inp...
FILE: tests/unit/test_color.py
function data_fixture (line 12) | def data_fixture():
function test_colorize (line 17) | def test_colorize(data_fixture):
FILE: tests/unit/test_config_file.py
function test_find_alt_config (line 12) | def test_find_alt_config(request):
function test_find_alt_config_not_exist (line 20) | def test_find_alt_config_not_exist(request):
FILE: tests/unit/test_controller.py
function random_string (line 16) | def random_string():
function test_display_search_results_pretty_short (line 21) | def test_display_search_results_pretty_short(export_format):
function test_display_search_results_builtin_plugins (line 39) | def test_display_search_results_builtin_plugins(
FILE: tests/unit/test_editor.py
function test_read_template_file_with_no_file_raises_exception (line 19) | def test_read_template_file_with_no_file_raises_exception(mock_open, moc...
function test_read_template_file_with_valid_file_returns_text (line 29) | def test_read_template_file_with_valid_file_returns_text(mock_file, mock...
function test_get_template_path_when_exists_returns_correct_path (line 33) | def test_get_template_path_when_exists_returns_correct_path():
function test_get_template_path_when_doesnt_exist_returns_correct_path (line 41) | def test_get_template_path_when_doesnt_exist_returns_correct_path(mock_a...
FILE: tests/unit/test_export.py
function datestr (line 14) | def datestr():
function build_card_header (line 18) | def build_card_header(datestr):
class TestFancy (line 24) | class TestFancy:
method test_too_small_linewrap (line 25) | def test_too_small_linewrap(self, datestr):
class TestYaml (line 35) | class TestYaml:
method test_export_to_nonexisting_folder (line 37) | def test_export_to_nonexisting_folder(self, mock_open):
FILE: tests/unit/test_install.py
function test_initialize_autocomplete_runs_without_readline (line 13) | def test_initialize_autocomplete_runs_without_readline():
FILE: tests/unit/test_journals_folder_journal.py
function test_get_day_files_expected_filtering (line 42) | def test_get_day_files_expected_filtering(inputs_and_outputs):
FILE: tests/unit/test_os_compat.py
function test_on_windows (line 31) | def test_on_windows(systems):
function test_on_posix (line 55) | def test_on_posix(systems):
function test_split_args_on_windows (line 72) | def test_split_args_on_windows(args):
function test_split_args_on_not_windows (line 88) | def test_split_args_on_not_windows(args):
FILE: tests/unit/test_output.py
function test_print_msg_calls_print_msgs_as_list_with_style (line 12) | def test_print_msg_calls_print_msgs_as_list_with_style(print_msgs):
function test_print_msg_calls_print_msgs_with_kwargs (line 19) | def test_print_msg_calls_print_msgs_with_kwargs(print_msgs):
FILE: tests/unit/test_override.py
function minimal_config (line 16) | def minimal_config():
function expected_args (line 26) | def expected_args(overrides):
function test_apply_override (line 55) | def test_apply_override(minimal_config):
function test_override_dot_notation (line 61) | def test_override_dot_notation(minimal_config):
function test_multiple_overrides (line 67) | def test_multiple_overrides(minimal_config):
function test_recursively_apply (line 83) | def test_recursively_apply():
function test_get_config_node (line 89) | def test_get_config_node(minimal_config):
function test_get_kv_from_pair (line 95) | def test_get_kv_from_pair():
class TestDotNotationToList (line 102) | class TestDotNotationToList:
method test_unpack_dots_to_list (line 103) | def test_unpack_dots_to_list(self):
method test_sequential_delimiters (line 108) | def test_sequential_delimiters(self):
FILE: tests/unit/test_parse_args.py
function cli_as_dict (line 12) | def cli_as_dict(str):
function expected_args (line 18) | def expected_args(**kwargs):
function test_empty (line 53) | def test_empty():
function test_contains_alone (line 57) | def test_contains_alone():
function test_debug_alone (line 61) | def test_debug_alone():
function test_delete_alone (line 65) | def test_delete_alone():
function test_change_time_alone (line 69) | def test_change_time_alone():
function test_diagnostic_alone (line 76) | def test_diagnostic_alone():
function test_edit_alone (line 84) | def test_edit_alone():
function test_encrypt_alone (line 88) | def test_encrypt_alone():
function test_decrypt_alone (line 94) | def test_decrypt_alone():
function test_end_date_alone (line 100) | def test_end_date_alone():
function test_not_empty (line 106) | def test_not_empty():
function test_not_alone (line 112) | def test_not_alone():
function test_not_multiple_alone (line 116) | def test_not_multiple_alone():
function test_not_mixed (line 131) | def test_not_mixed(cli):
function test_not_interspersed (line 136) | def test_not_interspersed():
function test_export_alone (line 141) | def test_export_alone():
function test_import_alone (line 145) | def test_import_alone():
function test_file_flag_alone (line 151) | def test_file_flag_alone():
function test_limit_alone (line 158) | def test_limit_alone():
function test_limit_shorthand_alone (line 163) | def test_limit_shorthand_alone():
function test_list_alone (line 168) | def test_list_alone():
function test_on_date_alone (line 174) | def test_on_date_alone():
function test_month_alone (line 178) | def test_month_alone():
function test_day_alone (line 185) | def test_day_alone():
function test_year_alone (line 190) | def test_year_alone():
function test_today_in_history_alone (line 195) | def test_today_in_history_alone():
function test_short_alone (line 199) | def test_short_alone():
function test_starred_alone (line 203) | def test_starred_alone():
function test_start_date_alone (line 207) | def test_start_date_alone():
function test_and_alone (line 212) | def test_and_alone():
function test_tags_alone (line 216) | def test_tags_alone():
function test_text_alone (line 220) | def test_text_alone():
function test_version_alone (line 226) | def test_version_alone():
function test_editor_override (line 232) | def test_editor_override():
function test_color_override (line 237) | def test_color_override():
function test_multiple_overrides (line 243) | def test_multiple_overrides():
function test_and_ordering (line 268) | def test_and_ordering(cli):
function test_edit_ordering (line 283) | def test_edit_ordering(cli):
class TestDeserialization (line 288) | class TestDeserialization:
method test_deserialize_multiword_strings (line 297) | def test_deserialize_multiword_strings(self, input_str):
method test_deserialize_multiple_datatypes (line 303) | def test_deserialize_multiple_datatypes(self):
FILE: tests/unit/test_path.py
function home_dir_str (line 17) | def home_dir_str(monkeypatch):
function random_test_var (line 25) | def random_test_var(monkeypatch):
function test_home_dir (line 32) | def test_home_dir(home_dir_str):
function test_expand_path_actually_expands_mac_linux (line 41) | def test_expand_path_actually_expands_mac_linux(path):
function test_expand_path_actually_expands_windows (line 51) | def test_expand_path_actually_expands_windows(path):
function test_expand_path_expands_into_correct_value_mac_linux (line 63) | def test_expand_path_expands_into_correct_value_mac_linux(paths):
function test_expand_path_expands_into_correct_value_windows (line 76) | def test_expand_path_expands_into_correct_value_windows(paths):
function test_expand_path_expands_into_random_env_value_mac_linux (line 83) | def test_expand_path_expands_into_random_env_value_mac_linux(_, random_t...
function test_expand_path_expands_into_random_env_value_windows (line 92) | def test_expand_path_expands_into_random_env_value_windows(_, random_tes...
function test_absolute_path (line 101) | def test_absolute_path(mock_abspath, mock_expand_path):
FILE: tests/unit/test_time.py
function test_default_hour_is_added (line 11) | def test_default_hour_is_added():
function test_default_minute_is_added (line 17) | def test_default_minute_is_added():
function test_is_valid_date (line 42) | def test_is_valid_date(inputs):
Condensed preview — 233 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (741K chars).
[
{
"path": ".build/allow_all_python_version.py",
"chars": 198,
"preview": "import toml\n\npyproject = toml.load(\"pyproject.toml\")\n\npyproject[\"tool\"][\"poetry\"][\"dependencies\"][\"python\"] = \"*\"\n\nwith "
},
{
"path": ".gitattributes",
"chars": 95,
"preview": "*.journal text eol=lf\n*.feature text eol=lf\npoetry.lock text eol=lf\npyrpoject.toml text eol=lf\n"
},
{
"path": ".github/FUNDING.yml",
"chars": 667,
"preview": "# These are supported funding model platforms\n\ngithub: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [u"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.yaml",
"chars": 2037,
"preview": "name: Bug Report\ndescription: Create a report to help us improve\ntitle: \"Bug Report\"\nlabels: [ \":new:\", \"bug\" ]\nbody:\n "
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"chars": 28,
"preview": "blank_issues_enabled: false\n"
},
{
"path": ".github/ISSUE_TEMPLATE/documentation.yaml",
"chars": 1206,
"preview": "name: Documentation Change\ndescription: Request or report any updates to our documentation (https://jrnl.sh)\ntitle: Docu"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.yaml",
"chars": 1220,
"preview": "name: Feature Request\ndescription: Suggest an idea for jrnl\ntitle: \"Feature Report\"\nlabels: [ \":new:\", \"enhancement\" ]\nb"
},
{
"path": ".github/ISSUE_TEMPLATE/support_request.yaml",
"chars": 1492,
"preview": "name: Support Request\ndescription: Get help with jrnl\ntitle: Support Request\nlabels: [ \":new:\", \"support\" ]\nbody:\n - ty"
},
{
"path": ".github/PULL_REQUEST_TEMPLATE.md",
"chars": 928,
"preview": "<!--\nThank you for wanting to contribute!\n\nPlease fill out this description, and the checklist below.\n\nHere are some key"
},
{
"path": ".github/actionlint-matcher.json",
"chars": 435,
"preview": "{\n \"problemMatcher\": [\n {\n \"owner\": \"actionlint\",\n \"pattern\": [\n {\n \"regexp\": \"^(?:\\\\x1b\\\\"
},
{
"path": ".github/actions/run_tests/action.yaml",
"chars": 1363,
"preview": "name: run jrnl tests\r\ndescription: Runs all jrnl tests on multiple platforms\r\ninputs:\r\n cache-string:\r\n description:"
},
{
"path": ".github/lock.yml",
"chars": 1232,
"preview": "# Configuration for Lock Threads - https://github.com/dessant/lock-threads-app\n\n# Number of days of inactivity before a "
},
{
"path": ".github/renovate.json",
"chars": 272,
"preview": "{\n \"$schema\": \"https://docs.renovatebot.com/renovate-schema.json\",\n \"extends\": [\n \"config:base\"\n ],\n \"schedule\": "
},
{
"path": ".github/stale.yml",
"chars": 687,
"preview": "# Number of days of inactivity before an issue becomes stale\ndaysUntilStale: 60\n# Number of days of inactivity before a "
},
{
"path": ".github/workflows/changelog.yaml",
"chars": 6252,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nname: Changelog\n\non:\n p"
},
{
"path": ".github/workflows/docs.yaml",
"chars": 2131,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nname: Docs\n\non:\n push:\n"
},
{
"path": ".github/workflows/release.yaml",
"chars": 3270,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nname: Release\non:\n work"
},
{
"path": ".github/workflows/testing_pipelines.yaml",
"chars": 804,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nname: Testing Pipeline F"
},
{
"path": ".github/workflows/testing_prs.yaml",
"chars": 1145,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nname: Testing\n\non:\n pus"
},
{
"path": ".github/workflows/testing_schedule.yaml",
"chars": 694,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nname: Testing\n\non:\n sch"
},
{
"path": ".gitignore",
"chars": 1046,
"preview": "# Byte-compiled DLL and Shared Library files\n*.py[cod]\n*.so\n\n# Packages\n*.egg\n*.egg-info/\n.installed.cfg\nbin/\nbuild/\ndev"
},
{
"path": ".readthedocs.yaml",
"chars": 567,
"preview": "# readthedocs.yml\n# Read the Docs configuration file\n# See https://docs.readthedocs.io/en/stable/config-file/v2.html for"
},
{
"path": "CHANGELOG.md",
"chars": 88472,
"preview": "# Changelog\n\n## [v4.3](https://pypi.org/project/jrnl/v4.3/) (2026-02-24)\n\n[Full Changelog](https://github.com/jrnl-org/j"
},
{
"path": "CODE_OF_CONDUCT.md",
"chars": 5202,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participa"
},
{
"path": "CONTRIBUTING.md",
"chars": 185,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Contributing\n\nSee"
},
{
"path": "LICENSE.md",
"chars": 34916,
"preview": "### GNU GENERAL PUBLIC LICENSE\n\nVersion 3, 29 June 2007\n\nCopyright (C) 2007 Free Software Foundation, Inc.\n<https://fsf."
},
{
"path": "README.md",
"chars": 3121,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n<p align=\"center\">\n"
},
{
"path": "SECURITY.md",
"chars": 455,
"preview": "# Security\r\n\r\nIf you've discovered a potential security issue in jrnl, please contact the maintainers at [maintainers@jr"
},
{
"path": "docs/advanced.md",
"chars": 3677,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Advanced Usage\n\n#"
},
{
"path": "docs/contributing.md",
"chars": 7485,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Contributing to j"
},
{
"path": "docs/encryption.md",
"chars": 5087,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Encryption\n\n## A "
},
{
"path": "docs/external-editors.md",
"chars": 4449,
"preview": "<!--\r\nCopyright © 2012-2023 jrnl contributors\r\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\r\n-->\r\n\r\n# External edi"
},
{
"path": "docs/formats.md",
"chars": 11204,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Formats\n\n`jrnl` s"
},
{
"path": "docs/installation.md",
"chars": 1161,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Getting started\n\n"
},
{
"path": "docs/journal-types.md",
"chars": 2971,
"preview": "<!--\r\nCopyright © 2012-2023 jrnl contributors\r\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\r\n-->\r\n\r\n# Journal Type"
},
{
"path": "docs/overview.md",
"chars": 2426,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Overview\n\n`jrnl` "
},
{
"path": "docs/privacy-and-security.md",
"chars": 8970,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Privacy and Secur"
},
{
"path": "docs/reference-command-line.md",
"chars": 5202,
"preview": "<!--\r\nCopyright © 2012-2023 jrnl contributors\r\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\r\n-->\r\n\r\n# Command Line"
},
{
"path": "docs/reference-config-file.md",
"chars": 4412,
"preview": "<!--\r\nCopyright © 2012-2023 jrnl contributors\r\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\r\n-->\r\n\r\n# Configuratio"
},
{
"path": "docs/tips-and-tricks.md",
"chars": 6429,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Tips and Tricks\n\n"
},
{
"path": "docs/usage.md",
"chars": 8351,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n# Basic Usage #\n\n`j"
},
{
"path": "docs_theme/assets/colors.css",
"chars": 657,
"preview": "/*\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n*/\n\n:root {\n /* For dark "
},
{
"path": "docs_theme/assets/highlight.css",
"chars": 2502,
"preview": "/*\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n\nAtom One Dark With suppor"
},
{
"path": "docs_theme/assets/index.css",
"chars": 6969,
"preview": "/*\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n*/\n\n/* reset */article,asi"
},
{
"path": "docs_theme/assets/theme.css",
"chars": 7360,
"preview": "/*\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n*/\n\n/* -------------------"
},
{
"path": "docs_theme/breadcrumbs.html",
"chars": 2582,
"preview": "<!--\nCopied from https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/breadcrumbs.html\nThen lightly mo"
},
{
"path": "docs_theme/index.html",
"chars": 6546,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n<!DOCTYPE html>\n<ht"
},
{
"path": "docs_theme/index.js",
"chars": 13,
"preview": "var typed2 =\n"
},
{
"path": "docs_theme/main.html",
"chars": 555,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n{% extends \"base.ht"
},
{
"path": "docs_theme/requirements.txt",
"chars": 26,
"preview": "mkdocs>=1.4\njinja2==3.1.6\n"
},
{
"path": "docs_theme/search.html",
"chars": 839,
"preview": "<!--\nCopyright © 2012-2023 jrnl contributors\nLicense: https://www.gnu.org/licenses/gpl-3.0.html\n-->\n\n{% extends \"main.ht"
},
{
"path": "issue_template.md",
"chars": 182,
"preview": "# Stop\n\nPlease don't file a blank issue.\n\nFill out one of the templates from the link below and we'll be better able to\n"
},
{
"path": "jrnl/__init__.py",
"chars": 212,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\ntry:\n from jrnl.__ver"
},
{
"path": "jrnl/__main__.py",
"chars": 182,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport sys\n\nfrom jrnl.ma"
},
{
"path": "jrnl/__version__.py",
"chars": 21,
"preview": "__version__ = \"v4.3\"\n"
},
{
"path": "jrnl/args.py",
"chars": 13963,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport argparse\nimport r"
},
{
"path": "jrnl/color.py",
"chars": 3226,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport re\nfrom string im"
},
{
"path": "jrnl/commands.py",
"chars": 5159,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\n\"\"\"\nFunctions in this fi"
},
{
"path": "jrnl/config.py",
"chars": 7056,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport argparse\nimport l"
},
{
"path": "jrnl/controller.py",
"chars": 13798,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\nimport sy"
},
{
"path": "jrnl/editor.py",
"chars": 3592,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\nimport os"
},
{
"path": "jrnl/encryption/BaseEncryption.py",
"chars": 1479,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\nfrom abc "
},
{
"path": "jrnl/encryption/BaseKeyEncryption.py",
"chars": 191,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom .BaseEncryption imp"
},
{
"path": "jrnl/encryption/BasePasswordEncryption.py",
"chars": 2446,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\n\nfrom jrn"
},
{
"path": "jrnl/encryption/Jrnlv1Encryption.py",
"chars": 1656,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport hashlib\nimport lo"
},
{
"path": "jrnl/encryption/Jrnlv2Encryption.py",
"chars": 1849,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport base64\nimport log"
},
{
"path": "jrnl/encryption/NoEncryption.py",
"chars": 570,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\n\nfrom jrn"
},
{
"path": "jrnl/encryption/__init__.py",
"chars": 953,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom enum import Enum\nfr"
},
{
"path": "jrnl/exception.py",
"chars": 634,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import TYPE_"
},
{
"path": "jrnl/install.py",
"chars": 5848,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport contextlib\nimport"
},
{
"path": "jrnl/journals/DayOneJournal.py",
"chars": 8968,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport contextlib\nimport"
},
{
"path": "jrnl/journals/Entry.py",
"chars": 7337,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport datetime\nimport l"
},
{
"path": "jrnl/journals/FolderJournal.py",
"chars": 5718,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport codecs\nimport os\n"
},
{
"path": "jrnl/journals/Journal.py",
"chars": 18835,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport datetime\nimport l"
},
{
"path": "jrnl/journals/__init__.py",
"chars": 156,
"preview": "from .DayOneJournal import DayOne\nfrom .Entry import Entry\nfrom .FolderJournal import Folder\nfrom .Journal import Journa"
},
{
"path": "jrnl/keyring.py",
"chars": 1044,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport keyring\n\nfrom jrn"
},
{
"path": "jrnl/main.py",
"chars": 2262,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\nimport sy"
},
{
"path": "jrnl/messages/Message.py",
"chars": 408,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import TYPE_"
},
{
"path": "jrnl/messages/MsgStyle.py",
"chars": 2252,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom enum import Enum\nfr"
},
{
"path": "jrnl/messages/MsgText.py",
"chars": 9395,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom enum import Enum\n\n\n"
},
{
"path": "jrnl/messages/__init__.py",
"chars": 281,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom jrnl.messages impor"
},
{
"path": "jrnl/os_compat.py",
"chars": 414,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport shlex\nfrom sys im"
},
{
"path": "jrnl/output.py",
"chars": 3767,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport textwrap\nfrom typ"
},
{
"path": "jrnl/override.py",
"chars": 2468,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import TYPE_"
},
{
"path": "jrnl/path.py",
"chars": 2065,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport os.path\nfrom path"
},
{
"path": "jrnl/plugins/__init__.py",
"chars": 1648,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import Type\n"
},
{
"path": "jrnl/plugins/calendar_heatmap_exporter.py",
"chars": 4859,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport calendar\nfrom dat"
},
{
"path": "jrnl/plugins/dates_exporter.py",
"chars": 923,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import TYPE_"
},
{
"path": "jrnl/plugins/fancy_exporter.py",
"chars": 3950,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\nimport os"
},
{
"path": "jrnl/plugins/jrnl_importer.py",
"chars": 1548,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport sys\nfrom typing i"
},
{
"path": "jrnl/plugins/json_exporter.py",
"chars": 2565,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport json\nfrom typing "
},
{
"path": "jrnl/plugins/markdown_exporter.py",
"chars": 3308,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport os\nimport re\nfrom"
},
{
"path": "jrnl/plugins/tag_exporter.py",
"chars": 1236,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import TYPE_"
},
{
"path": "jrnl/plugins/text_exporter.py",
"chars": 3843,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport errno\nimport os\ni"
},
{
"path": "jrnl/plugins/util.py",
"chars": 2143,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom collections import "
},
{
"path": "jrnl/plugins/xml_exporter.py",
"chars": 2604,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom typing import TYPE_"
},
{
"path": "jrnl/plugins/yaml_exporter.py",
"chars": 5323,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport os\nimport re\nfrom"
},
{
"path": "jrnl/prompt.py",
"chars": 2086,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom jrnl.messages impor"
},
{
"path": "jrnl/templates/sample.template",
"chars": 220,
"preview": "---\nextension: txt\n---\n\n{% block journal %}\n{% for entry in entries %}\n{% include entry %}\n{% endfor %}\n\n{% endblock %}\n"
},
{
"path": "jrnl/time.py",
"chars": 3395,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport datetime\n\nFAKE_YE"
},
{
"path": "jrnl/upgrade.py",
"chars": 6163,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport logging\nimport os"
},
{
"path": "mkdocs.yml",
"chars": 1099,
"preview": "site_name: jrnl\nsite_url: https://jrnl.sh\ntheme:\n name: readthedocs\n custom_dir: docs_theme\n static_templates:\n "
},
{
"path": "package.json",
"chars": 55,
"preview": "{\n \"devDependencies\": {\n \"pa11y-ci\": \"4.0.0\"\n }\n}\n"
},
{
"path": "pyproject.toml",
"chars": 4401,
"preview": "[project]\nname = \"jrnl\"\ndescription = \"Collect your thoughts and notes without leaving the command line.\"\nlicense = \"GPL"
},
{
"path": "tasks.py",
"chars": 1411,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nimport json\nimport os\nim"
},
{
"path": "tests/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "tests/bdd/features/actions.feature",
"chars": 4726,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Test combinatio"
},
{
"path": "tests/bdd/features/build.feature",
"chars": 350,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Build process\n\n"
},
{
"path": "tests/bdd/features/change_time.feature",
"chars": 12132,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Change entry ti"
},
{
"path": "tests/bdd/features/config_file.feature",
"chars": 7380,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Multiple journa"
},
{
"path": "tests/bdd/features/core.feature",
"chars": 732,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Functionality o"
},
{
"path": "tests/bdd/features/datetime.feature",
"chars": 9745,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Reading and wri"
},
{
"path": "tests/bdd/features/delete.feature",
"chars": 8585,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Delete entries "
},
{
"path": "tests/bdd/features/encrypt.feature",
"chars": 4372,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Encrypting and "
},
{
"path": "tests/bdd/features/file_storage.feature",
"chars": 3667,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Journals iterac"
},
{
"path": "tests/bdd/features/format.feature",
"chars": 32740,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Custom formats\n"
},
{
"path": "tests/bdd/features/import.feature",
"chars": 4215,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Importing data\n"
},
{
"path": "tests/bdd/features/install.feature",
"chars": 4055,
"preview": "Feature: Installing jrnl\n\n Scenario: Install jrnl with default options\n Given we use no config\n When we"
},
{
"path": "tests/bdd/features/multiple_journals.feature",
"chars": 4564,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Multiple journa"
},
{
"path": "tests/bdd/features/override.feature",
"chars": 4471,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Implementing Ru"
},
{
"path": "tests/bdd/features/password.feature",
"chars": 4952,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Using the insta"
},
{
"path": "tests/bdd/features/search.feature",
"chars": 16818,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Searching in a "
},
{
"path": "tests/bdd/features/star.feature",
"chars": 1600,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Starring entrie"
},
{
"path": "tests/bdd/features/tag.feature",
"chars": 2059,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Tagging\n# See s"
},
{
"path": "tests/bdd/features/template.feature",
"chars": 3179,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Using templates"
},
{
"path": "tests/bdd/features/upgrade.feature",
"chars": 2825,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Upgrading Journ"
},
{
"path": "tests/bdd/features/write.feature",
"chars": 14483,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nFeature: Writing new ent"
},
{
"path": "tests/bdd/test_features.py",
"chars": 937,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom pytest_bdd import s"
},
{
"path": "tests/conftest.py",
"chars": 1462,
"preview": "# Copyright © 2012-2023 jrnl contributors\n# License: https://www.gnu.org/licenses/gpl-3.0.html\n\nfrom pytest import mark\n"
},
{
"path": "tests/data/configs/basic_dayone.yaml",
"chars": 294,
"preview": "colors:\n date: none\n title: none\n body: none\n tags: none\ndefault_hour: 9\ndefault_minute: 0\neditor: noop\nencrypt: fal"
},
{
"path": "tests/data/configs/basic_encrypted.yaml",
"chars": 297,
"preview": "colors:\n date: none\n title: none\n body: none\n tags: none\ndefault_hour: 9\ndefault_minute: 0\neditor: noop\nencrypt: tru"
},
{
"path": "tests/data/configs/basic_folder.yaml",
"chars": 287,
"preview": "colors:\n date: none\n title: none\n body: none\n tags: none\ndefault_hour: 9\ndefault_minute: 0\neditor: noop\nencrypt: fal"
},
{
"path": "tests/data/configs/basic_onefile.yaml",
"chars": 296,
"preview": "colors:\n date: none\n title: none\n body: none\n tags: none\ndefault_hour: 9\ndefault_minute: 0\neditor: noop\nencrypt: fal"
},
{
"path": "tests/data/configs/brackets.yaml",
"chars": 228,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/brack"
},
{
"path": "tests/data/configs/bug153.yaml",
"chars": 286,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/bug15"
},
{
"path": "tests/data/configs/bug780.yaml",
"chars": 225,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/bug78"
},
{
"path": "tests/data/configs/dayone.yaml",
"chars": 227,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: noop\ntemplate: false\nencrypt: false\nhighlight: true\njournals:\n default: featu"
},
{
"path": "tests/data/configs/dayone_empty.yaml",
"chars": 294,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: noop\ntemplate: false\nencrypt: false\nhighlight: true\njournals:\n default: featu"
},
{
"path": "tests/data/configs/deletion.yaml",
"chars": 228,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/delet"
},
{
"path": "tests/data/configs/deletion_filters.yaml",
"chars": 236,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/delet"
},
{
"path": "tests/data/configs/duplicate_keys.yaml",
"chars": 582,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\ntemplate: false\ntemplate: false\njournals:\n "
},
{
"path": "tests/data/configs/editor-args.yaml",
"chars": 249,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: vim -f -c 'setf markdown'\nencrypt: false\nhighlight: true\njournals:\n default: "
},
{
"path": "tests/data/configs/editor.yaml",
"chars": 229,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"vim\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/si"
},
{
"path": "tests/data/configs/editor_empty_folder.yaml",
"chars": 227,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: 'vim'\ntemplate: false\nencrypt: false\nhighlight: true\njournals:\n default: feat"
},
{
"path": "tests/data/configs/editor_encrypted.yaml",
"chars": 295,
"preview": "colors:\n body: green\n date: blue\n tags: none\n title: yellow\ndefault_hour: 9\ndefault_minute: 0\neditor: \"vim\"\nencrypt:"
},
{
"path": "tests/data/configs/editor_markdown_extension.yaml",
"chars": 335,
"preview": "default_hour: 9\ndefault_minute: 0\nencrypt: false\nhighlight: true\neditor: \"vim\"\njournals:\n default: features/journals/ed"
},
{
"path": "tests/data/configs/empty_file.yaml",
"chars": 0,
"preview": ""
},
{
"path": "tests/data/configs/empty_folder.yaml",
"chars": 224,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\ntemplate: false\nencrypt: false\nhighlight: true\njournals:\n default: feature"
},
{
"path": "tests/data/configs/encrypted.yaml",
"chars": 228,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: true\ntemplate: false\nhighlight: true\njournals:\n default: features"
},
{
"path": "tests/data/configs/encrypted_old.json",
"chars": 283,
"preview": "{\n \"default_hour\": 9,\n \"default_minute\": 0,\n \"editor\": \"\",\n \"encrypt\": true,\n \"highlight\": true,\n \"jou"
},
{
"path": "tests/data/configs/encrypted_old.yaml",
"chars": 222,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: true\nhighlight: true\njournals:\n default: features/journals/encryp"
},
{
"path": "tests/data/configs/format_md.yaml",
"chars": 328,
"preview": "colors:\n body: none\n date: none\n tags: none\n title: none\ndefault_hour: 9\ndefault_minute: 0\ndisplay_format: markdown\n"
},
{
"path": "tests/data/configs/format_text.yaml",
"chars": 324,
"preview": "colors:\n body: none\n date: none\n tags: none\n title: none\ndefault_hour: 9\ndefault_minute: 0\ndisplay_format: text\nedit"
},
{
"path": "tests/data/configs/invalid_color.yaml",
"chars": 318,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/simpl"
},
{
"path": "tests/data/configs/linewrap_auto.yaml",
"chars": 289,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/simpl"
},
{
"path": "tests/data/configs/little_endian_dates.yaml",
"chars": 239,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/littl"
},
{
"path": "tests/data/configs/markdown-headings-335.yaml",
"chars": 302,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\ntemplate: false\njournals:\n default: feature"
},
{
"path": "tests/data/configs/missing_directory.yaml",
"chars": 401,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/missi"
},
{
"path": "tests/data/configs/missing_journal.yaml",
"chars": 288,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/missi"
},
{
"path": "tests/data/configs/mostlyreadabledates.yaml",
"chars": 239,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/mostl"
},
{
"path": "tests/data/configs/multiline-tags.yaml",
"chars": 295,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/multi"
},
{
"path": "tests/data/configs/multiline.yaml",
"chars": 290,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/multi"
},
{
"path": "tests/data/configs/multiple.yaml",
"chars": 484,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\ntemplate: false\njournals:\n default: feature"
},
{
"path": "tests/data/configs/no_colors.yaml",
"chars": 226,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/simpl"
},
{
"path": "tests/data/configs/no_default_journal.yaml",
"chars": 264,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\ntemplate: false\nencrypt: false\nhighlight: true\njournals:\n simple: features"
},
{
"path": "tests/data/configs/simple.yaml",
"chars": 287,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/simpl"
},
{
"path": "tests/data/configs/tags-216.yaml",
"chars": 289,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\ntemplate: false\njournals:\n default: feature"
},
{
"path": "tests/data/configs/tags-237.yaml",
"chars": 289,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\ntemplate: false\njournals:\n default: feature"
},
{
"path": "tests/data/configs/tags.yaml",
"chars": 285,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: ''\nencrypt: false\nhighlight: true\ntemplate: false\njournals:\n default: feature"
},
{
"path": "tests/data/configs/unreadabledates.yaml",
"chars": 296,
"preview": "default_hour: 9\ndefault_minute: 0\neditor: \"\"\nencrypt: false\nhighlight: true\njournals:\n default: features/journals/unrea"
},
{
"path": "tests/data/configs/upgrade_from_195.json",
"chars": 233,
"preview": "{\n\"default_hour\": 9,\n\"timeformat\": \"%Y-%m-%d %H:%M\",\n\"linewrap\": 80,\n\"encrypt\": false,\n\"editor\": \"\",\n\"default_minute\": 0"
},
{
"path": "tests/data/configs/upgrade_from_195_little_endian_dates.json",
"chars": 253,
"preview": "{\n\"default_hour\": 9,\n\"timeformat\": \"%d.%m.%Y %H:%M\",\n\"linewrap\": 80,\n\"encrypt\": false,\n\"editor\": \"\",\n\"default_minute\": 0"
},
{
"path": "tests/data/configs/upgrade_from_195_with_missing_encrypted_journal.json",
"chars": 284,
"preview": "{\n\"default_hour\": 9,\n\"timeformat\": \"%Y-%m-%d %H:%M\",\n\"linewrap\": 80,\n\"encrypt\": true,\n\"editor\": \"\",\n\"default_minute\": 0,"
},
{
"path": "tests/data/configs/upgrade_from_195_with_missing_journal.json",
"chars": 282,
"preview": "{\n\"default_hour\": 9,\n\"timeformat\": \"%Y-%m-%d %H:%M\",\n\"linewrap\": 80,\n\"encrypt\": false,\n\"editor\": \"\",\n\"default_minute\": 0"
},
{
"path": "tests/data/journals/basic_dayone.dayone/entries/D04D335AFED711EABA18FAFFC2100C3D.doentry",
"chars": 2145,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/basic_dayone.dayone/entries/FC8A86CAFED711EA8892FAFFC2100C3D.doentry",
"chars": 2292,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/basic_dayone.dayone/entries/FD8ABC8EFED711EABC35FAFFC2100C3D.doentry",
"chars": 1522,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/basic_encrypted.journal",
"chars": 4748,
"preview": "gAAAAABfb4gQBMqqGn_W8v_s7qCi14bX7inuCOKbsBqIUf7_ch14vTUp7lrysPFvhBp5vGijTwDIbk4LKoIISj8NwM31I8L0zEbMx9y6iyF_zseGGNxBvNN0"
},
{
"path": "tests/data/journals/basic_folder/2020/08/29.txt",
"chars": 1296,
"preview": "[2020-08-29 11:11:00 AM] Entry the first.\nLorem @ipsum dolor sit amet, consectetur adipiscing elit. Praesent malesuada\nq"
},
{
"path": "tests/data/journals/basic_folder/2020/08/31.txt",
"chars": 1496,
"preview": "[2020-08-31 02:32:00 PM] A second entry in what I hope to be a long series. *\nSed sit amet metus et sapien feugiat eleme"
},
{
"path": "tests/data/journals/basic_folder/2020/09/24.txt",
"chars": 697,
"preview": "[2020-09-24 09:14:00 AM] The third entry finally after weeks without writing.\nI'm so excited about emojis. 💯 🎶 💩\n\nDonec "
},
{
"path": "tests/data/journals/basic_folder/2020/09/should-be-ignored.txt",
"chars": 276,
"preview": "[2022-03-02 9:25:00 AM] This file should be ignored (month)\nThis text file is in a folder journal's month directory (\"20"
},
{
"path": "tests/data/journals/basic_folder/2020/should-be-ignored.txt",
"chars": 271,
"preview": "[2022-03-02 9:25:00 AM] This file should be ignored (year)\nThis text file is in a folder journal's year directory (\"2020"
},
{
"path": "tests/data/journals/basic_folder/should-be-ignored.txt",
"chars": 262,
"preview": "[2022-03-02 9:25:00 AM] This file should be ignored (root)\nThis text file is in a folder journal's root directory, but i"
},
{
"path": "tests/data/journals/basic_onefile.journal",
"chars": 3476,
"preview": "[2020-08-29 11:11] Entry the first.\n\nLorem @ipsum dolor sit amet, consectetur adipiscing elit. Praesent malesuada\nquis e"
},
{
"path": "tests/data/journals/brackets.journal",
"chars": 58,
"preview": "[2019-07-08 05:42] Entry subject\n[1] line starting with 1\n"
},
{
"path": "tests/data/journals/bug153.dayone/entries/B40EE704E15846DE8D45C44118A4D511.doentry",
"chars": 1622,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\"\n\"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/bug153.dayone/entries/B40EE704E15846DE8D45C44118A4D512.doentry",
"chars": 1474,
"preview": "<dict>\n <key>Creation Date</key>\n <date>2013-10-27T02:27:27Z</date>\n <key>Creator</key>\n <dict>\n <key"
},
{
"path": "tests/data/journals/bug780.dayone/entries/48A25033B34047C591160A4480197D8B.doentry",
"chars": 841,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/dayone.dayone/entries/044F3747A38546168B572C2E3F217FA2.doentry",
"chars": 895,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/dayone.dayone/entries/0BDDD6CDA43C4A9AA2681517CC35AD9D.doentry",
"chars": 1195,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/dayone.dayone/entries/422BC895507944A291E6FC44FC6B8BFC.doentry",
"chars": 839,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/dayone.dayone/entries/4BB1F46946AD439996C9B59DE7C4DDC1.doentry",
"chars": 798,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "tests/data/journals/dayone_empty.dayone/entries/empty.txt",
"chars": 86,
"preview": "This file exists to preserve the directory structure, but should be ignored by jrnl.\r\n"
},
{
"path": "tests/data/journals/deletion.journal",
"chars": 98,
"preview": "[2019-10-29 11:11] First entry.\n\n[2019-10-29 11:11] Second entry.\n\n[2019-10-29 11:13] Third entry."
},
{
"path": "tests/data/journals/deletion_filters.journal",
"chars": 417,
"preview": "[2019-10-01 08:00] It's just another day in October.\nNot much to write about.\n\n[2020-01-01 08:00] Happy New Year! \nSo th"
},
{
"path": "tests/data/journals/empty_folder/empty",
"chars": 20,
"preview": "Nothing to see here\n"
},
{
"path": "tests/data/journals/encrypted.journal",
"chars": 229,
"preview": "gAAAAABVIHB7tnwKExG7aC5ZbAbBL9SG2oY2GENeoOJ22i1PZigOvCYvrQN3kpsu0KGr7ay5K-_46R5YFlqJvtQ8anPH2FSITsaZy-l5Lz_5quw3rmzhLwAR"
},
{
"path": "tests/data/journals/little_endian_dates.journal",
"chars": 107,
"preview": "[09.06.2013 15:39] My first entry.\nEverything is alright\n\n[10.07.2013 15:40] Life is good.\nBut I'm better.\n"
},
{
"path": "tests/data/journals/markdown-headings-335.journal",
"chars": 292,
"preview": "[2015-04-14 13:23] Heading Test\n\nH1-1\n=\n\nH1-2\n===\n\nH1-3\n============================\n\nH2-1\n-\n\nH2-2\n---\n\nH2-3\n-----------"
}
]
// ... and 33 more files (download for full content)
About this extraction
This page contains the full source code of the jrnl-org/jrnl GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 233 files (680.1 KB), approximately 185.2k tokens, and a symbol index with 478 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.