diff --git a/.build/allow_all_python_version.py b/.build/allow_all_python_version.py new file mode 100644 index 00000000..5827709f --- /dev/null +++ b/.build/allow_all_python_version.py @@ -0,0 +1,8 @@ +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) diff --git a/.build/generate_changelog.sh b/.build/generate_changelog.sh deleted file mode 100755 index 58867c20..00000000 --- a/.build/generate_changelog.sh +++ /dev/null @@ -1,54 +0,0 @@ -#!/usr/bin/env bash - -FILENAME='CHANGELOG.md' - -# get the latest git tags -releases="$(git tag --sort=-creatordate | grep -Ev '(alpha|beta|rc)')" -release_latest=$(printf '%s' "$releases" | awk 'NR==1') -release_secondlatest=$(printf '%s' "$releases" | awk 'NR==2') - -echo "release_latest: ${release_latest}" -echo "release_secondlatest: ${release_secondlatest}" - -# 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" - -# determine correct tag to go back to -if [[ $TRAVIS_TAG == $release_latest ]]; then - echo "release build" - gittag=${release_secondlatest} -elif [[ ! -z $TRAVIS_TAG ]]; then - echo "beta elease" - gittag=${release_latest} -else - echo "merge into master or develop" - gittag=${release_latest} -fi -echo "gittag: ${gittag}" - -# find the line the tag starts on, and subtract 1 -tagline=$(grep -n "^## \[\?$gittag\]\?" "$FILENAME" | awk '{print $1}' FS=':' | head -1) -echo "tagline: ${tagline}" -[[ ! -z $tagline ]] && sed -i "1,$(expr $tagline - 1)d" "$FILENAME" - -# generate the changelog -docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator -t $GITHUB_TOKEN --since-tag $gittag - -# Put back our link (instead of the broken one) -sed -i 's!https://pypi.org/project/jrnl/HEAD/!https://github.com/jrnl-org/jrnl/!' "$FILENAME" - -BRANCH=$TRAVIS_BRANCH -if [[ $TRAVIS_BRANCH == $TRAVIS_TAG ]]; then - BRANCH='master' -fi - -git config --global user.email "jrnl.bot@gmail.com" -git config --global user.name "Jrnl Bot" -git checkout $BRANCH -git add "$FILENAME" -git commit -m "Updating changelog [ci skip]" -git push https://${GITHUB_TOKEN}@github.com/jrnl-org/jrnl.git $BRANCH - diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..540af298 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +*.journal text eol=lf +*.feature text eol=lf +poetry.lock text eol=lf +pyrpoject.toml text eol=lf diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..e9eb3084 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,12 @@ +# 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'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 02c0c251..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: ":new:, bug" -assignees: '' - ---- - -## Bug report - -Hello! Thank you for reporting an issue! -If you would fill out the below points, that would make our process a whole lot easier! - -* **Please tell us about your environment:** - - Jrnl version: (run `jrnl -v`) - - How you installed Jrnl - - Operating system [MacOS, Linux, Windows?] - -* **What is the current behavior?** - -* **Please provide the steps to reproduce and if possible a minimal demo of the problem** - -* **What is the expected behavior?** - -* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..0303209b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,74 @@ +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 diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 00000000..32e58533 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,41 @@ +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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8690ad71..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for jrnl -title: '' -labels: ":new:, enhancement" -assignees: '' - ---- - -## Feature Request - -Hello! Thank you for reporting an issue! -If you would fill out the below points, that would make our process a whole lot easier! - -* **What is the motivation / use case for changing the behavior?** - -* **Please provide examples of the usage** - -* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..9d0494c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,43 @@ +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 diff --git a/.github/ISSUE_TEMPLATE/support_request.md b/.github/ISSUE_TEMPLATE/support_request.md deleted file mode 100644 index d9608885..00000000 --- a/.github/ISSUE_TEMPLATE/support_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Support Request -about: Get help with jrnl -title: '' -labels: ":new:, support" -assignees: '' - ---- - -## Support request - -Hello! Thank you for reporting an issue! -If you would fill out the below points, that would make our process a whole lot easier! - -* **Please tell us about your environment:** - - - Jrnl version: (run `jrnl -v`) - - How you installed Jrnl - - - Operating system [MacOS, Linux, Windows?] - -* **What are you trying to do?** - -* **What have you tried?** - -* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) diff --git a/.github/ISSUE_TEMPLATE/support_request.yaml b/.github/ISSUE_TEMPLATE/support_request.yaml new file mode 100644 index 00000000..21c9bddc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support_request.yaml @@ -0,0 +1,54 @@ +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 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 986f10ee..37711e2c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,24 @@ + -*Short block of text containing: -- Relevant changes in text form -- related issues -- Motivation (if applicable) -- Example of usage (if applicable) -- Example of changes to config files (if applicable) -* ### Checklist -- [ ] The code change is tested and works locally. -- [ ] Tests pass. Your PR cannot be merged unless tests pass -- [ ] There is no commented out code in this PR. -- [ ] Have you followed the guidelines in our Contributing document? -- [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change? -- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? -- [ ] Have you written new tests for your core changes, as applicable? + +- [ ] 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. + diff --git a/.github/actionlint-matcher.json b/.github/actionlint-matcher.json new file mode 100644 index 00000000..4613e161 --- /dev/null +++ b/.github/actionlint-matcher.json @@ -0,0 +1,17 @@ +{ + "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 + } + ] + } + ] +} diff --git a/.github/actions/run_tests/action.yaml b/.github/actions/run_tests/action.yaml new file mode 100644 index 00000000..490a00c4 --- /dev/null +++ b/.github/actions/run_tests/action.yaml @@ -0,0 +1,46 @@ +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@v5 + 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@v4 + 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 diff --git a/.github/lock.yml b/.github/lock.yml new file mode 100644 index 00000000..8a093a62 --- /dev/null +++ b/.github/lock.yml @@ -0,0 +1,39 @@ +# 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 diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 00000000..5aa9f254 --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base" + ], + "schedule": [ "at any time" ], + "prConcurrentLimit": 10, + "prHourlyLimit": 10, + "reviewers": [ + "wren", + "micahellison" + ], + "labels": [ "packaging" ] +} diff --git a/.github/stale.yml b/.github/stale.yml index 323b3928..4df56d7b 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -4,8 +4,8 @@ daysUntilStale: 60 daysUntilClose: 7 # Issues with these labels will never be considered stale exemptLabels: - - ':star:' - - security + - ':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 diff --git a/.github/workflows/changelog.yaml b/.github/workflows/changelog.yaml new file mode 100644 index 00000000..a9347a13 --- /dev/null +++ b/.github/workflows/changelog.yaml @@ -0,0 +1,170 @@ +# 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@v4 + 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 + diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000..3f5fe714 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,76 @@ +# 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@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + 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@v4 + with: + path: .venv + key: ${{ runner.os }}-${{ hashFiles('poetry.lock') }}-${{ env.PYTHON_FULL_VERSION }}-${{ secrets.CACHE_STRING }} + + - name: npm cache + uses: actions/cache@v4 + with: + path: node_modules + key: ${{ runner.os }}-pa11y-v3 + + - name: Install dependencies + run: | + pip install poetry + poetry config --local virtualenvs.in-project true + poetry sync --no-root + npm install + 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 diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 00000000..f8e203b2 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,109 @@ +# 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@v5 + with: + python-version: '3.13' + + - name: Checkout repo + uses: actions/checkout@v4 + 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" diff --git a/.github/workflows/testing_pipelines.yaml b/.github/workflows/testing_pipelines.yaml new file mode 100644 index 00000000..fbba51f1 --- /dev/null +++ b/.github/workflows/testing_pipelines.yaml @@ -0,0 +1,35 @@ +# 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@v4 + - name: Check workflow files + uses: docker://rhysd/actionlint:latest + with: + args: -color diff --git a/.github/workflows/testing_prs.yaml b/.github/workflows/testing_prs.yaml new file mode 100644 index 00000000..42a3f86f --- /dev/null +++ b/.github/workflows/testing_prs.yaml @@ -0,0 +1,48 @@ +# 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' ] + os: [ ubuntu-latest, macos-latest, windows-latest ] + steps: + - run: git config --global core.autocrlf false + - uses: actions/checkout@v4 + - name: Run tests + uses: ./.github/actions/run_tests + with: + cache-string: ${{ secrets.CACHE_STRING }} diff --git a/.github/workflows/testing_schedule.yaml b/.github/workflows/testing_schedule.yaml new file mode 100644 index 00000000..9791349c --- /dev/null +++ b/.github/workflows/testing_schedule.yaml @@ -0,0 +1,28 @@ +# 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' ] + os: [ ubuntu-latest, macos-latest, windows-latest ] + steps: + - run: git config --global core.autocrlf false + - uses: actions/checkout@v4 + - name: Run tests + uses: ./.github/actions/run_tests + with: + cache-string: ${{ secrets.CACHE_STRING }} diff --git a/.github_changelog_generator b/.github_changelog_generator deleted file mode 100644 index 983e4119..00000000 --- a/.github_changelog_generator +++ /dev/null @@ -1,11 +0,0 @@ -project=jrnl -user=jrnl-org -base=CHANGELOG.md -issues=false -issues-wo-labels=false -include-labels=bug,enhancement,documentation,build,deprecated -release-url=https://pypi.org/project/jrnl/%s/ -add-sections={ "build": { "prefix": "**Build:**", "labels": ["build"]}, "docs": { "prefix": "**Updated documentation:**", "labels": ["documentation"]}} -exclude-tags-regex=(alpha|beta|rc) -verbose=false - diff --git a/.gitignore b/.gitignore index 2382cabe..938692b0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,54 +1,63 @@ +# Byte-compiled DLL and Shared Library files *.py[cod] - -# C extensions *.so -.python-version # Packages *.egg -*.egg-info -dist -build -eggs -parts -bin -var -sdist -develop-eggs +*.egg-info/ .installed.cfg -lib -lib64 +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 -pip-log.txt .DS_Store .travis-solo Icon +pip-log.txt # Documentation _build _sources _static +coverage.xml +exp/ objects.inv searchindex.js -# MS Visual Studio (PyTools) -obj -*.pyproj -*.sln -*.suo - -# virtaulenv +# virtualenv +.venv*/ env/ env*/ +venv*/ -# PyCharm Project files -.idea/ - -# export testing director -exp/ - -_extras/ -*.sublime-* -site/ +# 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 \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..9ef346b7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,28 @@ +# 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 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 7263ff8c..00000000 --- a/.travis.yml +++ /dev/null @@ -1,146 +0,0 @@ -dist: xenial # required for Python >= 3.7 -os: linux -language: python - -cache: - - pip - -git: - depth: false - autocrlf: false - -before_install: - - date - -install: - - pip install poetry - - poetry install - - poetry run python --version - -script: - - poetry run behave - -aliases: - test_mac: &test_mac - os: osx - language: shell - osx_image: xcode11.2 - cache: - directories: - - $HOME/.pyenv/versions - before_install: - - eval "$(pyenv init -)" - - pyenv install -s $JRNL_PYTHON_VERSION - - pyenv global $JRNL_PYTHON_VERSION - - pip install --upgrade pip - - pip --version - test_windows: &test_windows - os: windows - language: shell - cache: - directories: - - /c/Python36 - - /c/Python37 - - /c/Python38 - before_install: - - choco install python --version $JRNL_PYTHON_VERSION - - python -m pip install --upgrade pip - - pip --version - -jobs: - fast_finish: true - allow_failures: - - python: nightly - - os: windows - - include: - - name: Lint, via Black - python: 3.8 - script: - - black --version - - black --check . --verbose --diff - - # Python 3.6 Tests - - name: Python 3.6 on Linux - python: 3.6 - - <<: *test_mac - name: Python 3.6 on MacOS - python: 3.6 - env: - - JRNL_PYTHON_VERSION=3.6.8 - - <<: *test_windows - name: Python 3.6 on Windows - python: 3.6 - env: - - JRNL_PYTHON_VERSION=3.6.8 - - PATH=/c/Python36:/c/Python36/Scripts:$PATH - - # Python 3.7 Tests - - name: Python 3.7 on Linux - python: 3.7 - - <<: *test_mac - name: Python 3.7 on MacOS - python: 3.7 - env: - - JRNL_PYTHON_VERSION=3.7.5 - - <<: *test_windows - name: Python 3.7 on Windows - python: 3.7 - env: - - JRNL_PYTHON_VERSION=3.7.5 - - PATH=/c/Python37:/c/Python37/Scripts:$PATH - - # Python 3.8 Tests - - name: Python 3.8 on Linux - python: 3.8 - - <<: *test_mac - name: Python 3.8 on MacOS - python: 3.8 - env: - - JRNL_PYTHON_VERSION=3.8.0 - - <<: *test_windows - name: Python 3.8 on Windows - python: 3.8 - env: - - JRNL_PYTHON_VERSION=3.8.0 - - PATH=/c/Python38:/c/Python38/Scripts:$PATH - - # ... and beyond! - - name: Python nightly on Linux - python: nightly - - # Specialty tests - - name: Python 3.7 on Linux, not UTC - python: 3.7 - env: - - TZ=America/Edmonton - - # Changelog for Unreleased changes - - stage: Update Changelog - if: (tag IS present) OR (branch = develop AND type NOT IN (pull_request)) - install: - - echo 'Skipping install' - script: - - ./.build/generate_changelog.sh - - - stage: Deploy - if: tag IS present - before_deploy: - - poetry version "$TRAVIS_TAG" - - echo __version__ = \"$TRAVIS_TAG\" > jrnl/__version__.py - - poetry build - deploy: - - provider: script - script: poetry publish - skip_cleanup: true - on: - branch: master - tags: true - after_deploy: - - git config --global user.email "jrnl.bot@gmail.com" - - git config --global user.name "Jrnl Bot" - - git checkout master - - git add pyproject.toml - - git commit -m "Incrementing version to ${TRAVIS_TAG} [ci skip]" - - git push https://${GITHUB_TOKEN}@github.com/jrnl-org/jrnl.git master - diff --git a/CHANGELOG.md b/CHANGELOG.md index c19dee9c..ba714328 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,27 +2,841 @@ ## [Unreleased](https://github.com/jrnl-org/jrnl/) -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.2...HEAD) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v4.2.1...HEAD) + +**Fixed bugs:** + +- poetry warning - "poetry.dev-dependencies" section is deprecated [\#1975](https://github.com/jrnl-org/jrnl/issues/1975) +- Homebrew autobump error on jrnl release [\#1961](https://github.com/jrnl-org/jrnl/issues/1961) + +**Build:** + +- Remove release step to publish to Homebrew [\#1994](https://github.com/jrnl-org/jrnl/pull/1994) ([micahellison](https://github.com/micahellison)) + +**Packaging:** + +- 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.2-beta2...v2.2) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.1.1...v2.2) **Implemented enhancements:** -- Update YAML exporter to handle Dayone format [\#773](https://github.com/jrnl-org/jrnl/pull/773) ([MinchinWeb](https://github.com/MinchinWeb)) - 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)) @@ -37,6 +851,7 @@ - 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)) @@ -56,7 +871,7 @@ ## [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.1-beta...v2.1.1) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.1.post2...v2.1.1) **Implemented enhancements:** @@ -79,7 +894,7 @@ ## [v2.1.post2](https://pypi.org/project/jrnl/v2.1.post2/) (2019-11-11) -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.1-beta6...v2.1.post2) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.0.1...v2.1.post2) **Fixed bugs:** @@ -97,7 +912,7 @@ ## [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.1-beta...v2.0.1) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.0.0...v2.0.1) **Implemented enhancements:** @@ -115,7 +930,9 @@ ## [v2.0.0](https://pypi.org/project/jrnl/v2.0.0/) (2019-08-24) -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.0-rc4...v2.0.0) +[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 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dc9e89f1..68716f88 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,65 +2,126 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers -pledge to making participation in our project and our community a harassment-free experience for -everyone, regardless of age, body size, 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 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 creating a positive environment include: +Examples of behavior that contributes to a positive environment for our +community include: -* Using welcoming and inclusive language Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism Focusing on what is best for the community Showing -* empathy towards other community members +* 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 by participants include: +Examples of unacceptable behavior include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks Public or private -* harassment Publishing others' private information, such as a physical or electronic - address, without explicit permission +* 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 -## Our Responsibilities +## Enforcement Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable behavior and are -expected to take appropriate and fair corrective action in response to any instances of unacceptable -behavior. +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. -Project maintainers 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, or -to ban temporarily or permanently any contributor for other behaviors 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 project spaces, and it also applies when an individual is -representing the project or its community in public spaces. Examples of representing a project or -community include using an official project e-mail address, posting via an official social media -account, or acting as an appointed representative at an online or offline event. Representation of a -project may be further defined and clarified by project maintainers. +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 contacting -the project team. All complaints will be reviewed and investigated and will result in a response -that is deemed necessary and appropriate to the circumstances. The project team is obligated to -maintain confidentiality with regard to the reporter of an incident. Further details of specific -enforcement policies may be posted separately. +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. -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face -temporary or permanent repercussions as determined by other members of the project's leadership. +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 1.4, available at -https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +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 https://www.contributor-covenant.org/faq +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 414a7091..dc078f3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,45 +1,8 @@ + + # Contributing -If you use jrnl, you can totally make our day by just saying "thanks for the code." It's your chance to make a programmer happy today! If you have a moment, let us know what you use jrnl for and how; it'll help us to make it even better! - - -# Table of Contents - * [Docs and Typos](#docs-and-typos) - * [Bugs](#bugs) - * [Feature requests and ideas](#feature-requests-and-ideas) - * [New programmers and programmers new to python](#new-programmers-and-programmers-new-to-python) - * [Developing jrnl](#developing-jrnl) - - -## Docs and Typos - -If you find a typo or a mistake in the docs, please fix it right away and send a pull request. The Right Way™ to fix the docs is to edit the `docs/*.md` files on the **master** branch. You can see the result if you run `make html` inside the project's root directory, which will open a browser that hot-reloads as you change the docs. This requires [mkdocs](https://www.mkdocs.org) to be installed. The `gh-pages` branch is automatically maintained and updates from `master`; you should never have to edit that. - -## Bugs - -Unfortunately, bugs happen. If you found one, please [open a new issue](https://github.com/jrnl-org/jrnl/issues/new/choose) and describe it as well as possible. If you're a programmer with some time, go ahead and send us a pull request that references the issue! We'll review as quickly as we can. - -## Feature requests and ideas - -So, you have an idea for a great feature? Awesome! We'd love to hear from you! 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. To us, that means: - -* be _slim_ -* have a simple interface -* avoid duplicating functionality - -## 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! - -## Developing jrnl - -The jrnl source uses [poetry](https://poetry.eustace.io/) for dependency management. You will need to install it to develop journal. - - * To run tests: `make test` (or `poetry run behave` if on Windows) - * To run the source: `poetry install` then `poetry shell` then run `jrnl` with or without arguments as necessary - -For testing, jrnl uses [behave](https://behave.readthedocs.io/). +See "[Contributing](docs/contributing.md)" in the `docs` directory. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 4419cd43..00000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2014-2019 Manuel Ebert - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..2fb2e74d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 . + +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 . diff --git a/Makefile b/Makefile deleted file mode 100644 index 79803508..00000000 --- a/Makefile +++ /dev/null @@ -1,29 +0,0 @@ -# A Makefile for commands I run frequently: - -clean: - rm -rf dist - rm -rf _static - rm -rf jrnl.egg-info - rm -rf _build - rm -rf _sources - rm -rf _static - rm -rf site/ - rm -f *.html - -html: - poetry run mkdocs serve - -format: ## check style with flake8 - poetry run black features jrnl - -lint: ## check style with flake8 - poetry run flake8 jrnl features --ignore E501 - -test: ## Run behave tests - poetry run behave - -build: - poetry build - -install: clean ## install the package to the active Python's site-packages - poetry install diff --git a/README.md b/README.md index 0f444ab2..a99f0ba8 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,85 @@ -jrnl [![Build Status](https://travis-ci.com/jrnl-org/jrnl.svg?branch=master)](https://travis-ci.com/jrnl-org/jrnl) [![Downloads](https://pepy.tech/badge/jrnl)](https://pepy.tech/project/jrnl) [![Version](http://img.shields.io/pypi/v/jrnl.svg?style=flat)](https://pypi.python.org/pypi/jrnl/) + + +

+ + + +

+ +jrnl + [![Testing](https://github.com/jrnl-org/jrnl/workflows/Testing/badge.svg)](https://github.com/jrnl-org/jrnl/actions?query=workflow%3ATesting) + [![Downloads](https://pepy.tech/badge/jrnl)](https://pepy.tech/project/jrnl) + [![Version](http://img.shields.io/pypi/v/jrnl.svg?style=flat)](https://pypi.python.org/pypi/jrnl/) + [![Homebrew](https://img.shields.io/homebrew/v/jrnl?style=flat-square)](https://formulae.brew.sh/formula/jrnl) + [![Gitter](https://img.shields.io/gitter/room/jrnl-org/jrnl)](https://gitter.im/jrnl-org/jrnl) + [![Changelog](https://img.shields.io/badge/changelog-on%20github-green)](https://github.com/jrnl-org/jrnl/blob/develop/CHANGELOG.md) ==== -_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new) on Github._ +_To get help, [submit an issue](https://github.com/jrnl-org/jrnl/issues/new/choose) on +GitHub._ -*jrnl* is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncing and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten. +`jrnl` is a simple journal application for the command line. -Optionally, your journal can be encrypted using the [256-bit AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). +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). -### Why keep a journal? +## In a Nutshell -Journals aren't just for people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it. +To make a new entry, just enter -In a Nutshell -------------- +``` sh +jrnl yesterday: Called in sick. Used the time to clean the house and write my +book. +``` -to make a new entry, just type +`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: - jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book. + [2012-03-29 09:00] Called in sick. + Used the time to clean the house and write my book. -and hit return. `yesterday:` will be interpreted as a timestamp. 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: +If you just call `jrnl`, you will be prompted to compose your entry - but you +can also configure _jrnl_ to use your external editor. - 2012-03-29 09:00 Called in sick. - Used the time to clean the house and spent 4h on writing my book. +For more information, please read the +[documentation](https://jrnl.sh). -If you just call `jrnl`, you will be prompted to compose your entry - but you can also configure _jrnl_ to use your external editor. +## Contributors -Known Issues ------------- -jrnl used to support integration with Day One, but no longer supports it since Day One 2 was released with a different backend. [See the GitHub issue for more information](https://github.com/jrnl-org/jrnl/issues/409). +### Maintainers -Authors -------- -Current 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)) -Original maintainer: +Please thank them if you like `jrnl`! - * Manuel Ebert ([maebert](https://github.com/maebert)) +### 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! + + + +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. + + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..44a0f958 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# 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/). diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 027bab94..00000000 --- a/docs/CNAME +++ /dev/null @@ -1,2 +0,0 @@ -jrnl.sh - diff --git a/docs/advanced.md b/docs/advanced.md index 0375da10..764ff98a 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -1,70 +1,27 @@ + + # Advanced Usage ## Configuration File -You can configure the way jrnl behaves in a configuration file. By -default, this is `~/.config/jrnl/jrnl.yaml`. If you have the `XDG_CONFIG_HOME` -variable set, the configuration file will be saved as -`$XDG_CONFIG_HOME/jrnl/jrnl.yaml`. +`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. -!!! note - On Windows, the configuration file is typically found at `%USERPROFILE%\.config\jrnl\jrnl.yaml`. - -The configuration file is a YAML file with the following options -and can be edited with a plain text editor. - -!!! note - Backup your config file before editing. Changes to the config file - have destructive effects on your journal! - - - `journals` - paths to your journal files - - `editor` - if set, executes this command to launch an external editor for - writing your entries, e.g. `vim`. Some editors require special - options to work properly, see `FAQ ` for details. - - `encrypt` - if `true`, encrypts your journal using AES. - - `tagsymbols` - Symbols to be interpreted as tags. (See note below) - - `default_hour` and `default_minute` - if you supply a date, such as `last thursday`, but no specific - time, the entry will be created at this time - - `timeformat` - how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference - - `highlight` - if `true`, tags will be highlighted in cyan. - - `linewrap` - controls the width of the output. Set to `false` if you don't - want to wrap long lines. - -!!! note - Although it seems intuitive to use the `#` - character for tags, there's a drawback: on most shells, this is - interpreted as a meta-character starting a comment. This means that if - you type - - > `jrnl Implemented endless scrolling on the #frontend of our website.` - - your bash will chop off everything after the `#` before passing it to - `jrnl`. To avoid this, wrap your input into quotation marks like - this: - - > `jrnl "Implemented endless scrolling on the #frontend of our website."` - - Or use the built-in prompt or an external editor to compose your - entries. - -## Multiple journal files +### Multiple journal files You can configure `jrnl`to use with multiple journals (eg. -`private` and `work`) by defining more journals in your `jrnl.yaml`, +`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 + default: ~/journal.txt + work: ~/work.txt ``` The `default` journal gets created the first time you start `jrnl` @@ -85,31 +42,76 @@ If your `jrnl.yaml` looks like this: ``` yaml encrypt: false journals: -default: ~/journal.txt -work: - journal: ~/work.txt - encrypt: true -food: ~/my_recipes.txt + 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 +`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 - Changing `encrypt` 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. + These overrides allow you to modify ***any*** field of your jrnl configuration. We trust that you know what you are doing. -## Known Issues +#### Examples: -### Unicode on Windows +``` sh +# Create an entry using the `stdin` prompt, for rapid logging +jrnl --config-override editor "" -The Windows shell prior to Windows 7 has issues with unicode encoding. -To use non-ascii characters, first tweak Python to recognize the encoding by adding `'cp65001': 'utf_8'`, to `Lib/encoding/aliases.py`. Then, change the codepage with `chcp 1252` before using `jrnl`. +# Populate a project's log +jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo find my towel -(Related issue: [#486](https://github.com/jrnl-org/jrnl/issues/486)) +# 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 +``` diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index 46eeb25c..00000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,79 +0,0 @@ -/* - -Atom One Dark With support for ReasonML by Gidi Morris, based off work by Daniel Gamage - -Original One Dark Syntax theme from https://github.com/atom/one-dark-syntax - -*/ -.hljs { - display: block; - overflow-x: auto; - padding: 0.5em; - line-height: 1.3em; - color: #e2e8f2; - background: #383e49; - border-radius: 5px; - font-size: 0.9rem; - line-height: 1.3rem; -} -.hljs-keyword, .hljs-operator { - color: #F92672; -} -.hljs-pattern-match { - color: #F92672; -} -.hljs-pattern-match .hljs-constructor { - color: #61aeee; -} -.hljs-function { - color: #61aeee; -} -.hljs-function .hljs-params { - color: #A6E22E; -} -.hljs-function .hljs-params .hljs-typing { - color: #FD971F; -} -.hljs-module-access .hljs-module { - color: #7e57c2; -} -.hljs-constructor { - color: #e2b93d; -} -.hljs-constructor .hljs-string { - color: #9CCC65; -} -.hljs-comment, .hljs-quote { - color: #b18eb1; - font-style: italic; -} -.hljs-doctag, .hljs-formula { - color: #c678dd; -} -.hljs-section, .hljs-name, .hljs-selector-tag, .hljs-deletion, .hljs-subst { - color: #e06c75; -} -.hljs-literal { - color: #56b6c2; -} -.hljs-string, .hljs-regexp, .hljs-addition, .hljs-attribute, .hljs-meta-string { - color: #98c379; -} -.hljs-built_in, .hljs-class .hljs-title { - color: #e6c07b; -} -.hljs-attr, .hljs-variable, .hljs-template-variable, .hljs-type, .hljs-selector-class, .hljs-selector-attr, .hljs-selector-pseudo, .hljs-number { - color: #d19a66; -} -.hljs-symbol, .hljs-bullet, .hljs-link, .hljs-meta, .hljs-selector-id, .hljs-title { - color: #61aeee; -} -.hljs-emphasis { - font-style: italic; -} -.hljs-strong { - font-weight: bold; -} -.hljs-link { - text-decoration: underline; -} diff --git a/docs/assets/theme.css b/docs/assets/theme.css deleted file mode 100644 index 687b3347..00000000 --- a/docs/assets/theme.css +++ /dev/null @@ -1,204 +0,0 @@ - -/* ------------------------------------------------------------ */ -/* Overrides for jrnl theme */ -/* ------------------------------------------------------------ */ - -:root { - --sidebar: #604385; - --sidebar-dark: #604385; - --off-white: rgba(255,255,255,.7); -} - -body.wy-body-for-nav, section.wy-nav-content-wrap { - background-color: rgb(252,252,252); -} - -pre { - background-color: transparent; - border: none; - margin: 1em -1em; -} - -pre code { - padding: 1em 1.5em !important; -} - -code { - background-color: transparent; -} - -h1,h2 ,h3, h4, h5, h6 { - font-family: "Open Sans", "Helvetica Neue", Helvetica, sans-serif; - font-weight: 600; - margin-top: 2rem; - margin-bottom: 0.5rem; -} -p, td, tr, div, li { - font-family: "Open Sans", "Helvetica Neue", Helvetica, sans-serif; - font-weight: 00; -} - -p { - margin: 1em 0em; -} - -/* No-one likes lines that are 400 characters long. */ -div.rst-content {max-width: 54em;} - -.wy-side-nav-search, .wy-menu-vertical li.current { - background-color: transparent; -} -.wy-nav-top { - background-image: linear-gradient(-211deg, #95699C 0%, #604385 100%); -} - -.wy-nav-top .fa-bars { - line-height: 50px; -} - -.wy-side-nav-search a.icon-home { - width: 100%; - max-width: 250px; - background-size: 100%; -} - -a.icon-home:before { - display: block; - width: 84px; - height: 70px; - content: ""; - background: url(../img/logo_white.svg) center center no-repeat; - margin: 10px auto; -} - -.wy-menu-vertical a, .wy-menu-vertical li ul li a {color: var(--off-white) !important; } - -.wy-menu-vertical a:hover, .wy-menu-vertical li.current a:hover { background-color: transparent !important; color: white !important;} -.wy-menu-vertical li.on a, .wy-menu-vertical li.current>a { - background: transparent; !important; - color: white !important; - border: none; - position: relative; - font-weight: 700 !important; - border-right: none !important; -} - -.wy-menu-vertical li.on a, .wy-menu-vertical li.current a { - border-right: none; -} - -.wy-menu-vertical li.on a, .wy-menu-vertical li.current>a:after { - display: block; - position: absolute; - right: 0em; - top: 0; - z-index: 999 !important; - content: ""; - width: 0; - height: 0; - border-top: 1em solid transparent; - border-bottom: 1em solid transparent; - border-right: 1em solid white; -} - -.rst-versions, .rst-versions .rst-current-version { display: none; } -.wy-menu-vertical span { - color: white !important; - font-size: 1.2em; - font-weight: 300 !important; -} -.wy-menu-vertical li a {color: var(--off-white) !important; font-weight: 300 !important;} - - -.wy-nav-side { - background-image: linear-gradient(211deg, #95699C 0%, #604385 100%); - font-weight: 300 !important; - height: 100%; -} - - -footer {display: none;} - -.wy-side-nav-search input[type=text], form .search-query { - background-color: rgba(0,0,0,.1) !important; - border: 1px solid rgba(255,255,255,.3); - box-shadow: none; - margin-bottom: 1em; - color: white !important; - font-weight: 500; -} - -.wy-side-nav-search input[type=text]::placeholder, form .search-query::placeholder { - color: var(--off-white) !important; -} - -.toctree-l2 a:first-child {display: none;} - -/* ------------------------------------------------------------ */ -/* Logo: ; */ -/* ------------------------------------------------------------ */ - -.logo { - width: 128px; - height: 128px; - vertical-align: middle; - margin-right: 1em; -} - -/* ------------------------------------------------------------ */ -/* Code blocks in callouts */ -/* ------------------------------------------------------------ */ - -div.admonition { - border-radius: 5px; - margin: 1em -1em; -} -div.admonition p.admonition-title { - border-top-left-radius: 5px; - border-top-right-radius: 5px; -} -div.admonition > p { - padding: 0em .5em; -} - - -div.admonition div.highlight { - background: none !important; -} -div.admonition div.highlight pre { - background-color: rgba(255,255,255,.5) !important; -} - -/* ------------------------------------------------------------ */ -/* Fancy ordered lists. */ -/* ------------------------------------------------------------ */ - -ol { - counter-reset:li; - margin-left: 0px; - padding: 0; -} - -ol li { - list-style: none !important; - margin-bottom: 1.5em; - margin-left: 3em !important; -} - -ol > li:before { - content:counter(li); - counter-increment:li; - background-color: var(--sidebar); - border-radius: 50%; - display: block; - float: left; - margin-left: -3em; - margin-top: -.3em; - width: 2em; - height: 2em; - color: var(--sidebar-dark); - text-align: center; - line-height: 2em; - font-weight: 600; -} - diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 00000000..393add7b --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,132 @@ + + +# 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! diff --git a/docs/encryption.md b/docs/encryption.md index 35a26313..a612bfd1 100644 --- a/docs/encryption.md +++ b/docs/encryption.md @@ -1,98 +1,155 @@ + + # Encryption -## Encrypting and decrypting +## A Note on Security -If you don’t choose to encrypt your file when you run -`jrnl` for the first time, you can encrypt -your existing journal file or change its password using this: +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 +jrnl --encrypt [FILENAME] ``` -If it is already encrypted, you will first be asked for the current -password. You can then enter a new password and your plain journal will -replaced by the encrypted file. Conversely, +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 +jrnl --decrypt [FILENAME] ``` -will replace your encrypted journal file with a journal in plain text. You -can also specify a filename, i.e. `jrnl --decrypt plain_text_copy.txt`, -to leave your original file untouched. +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. -## Storing passwords in your keychain +!!! 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. -Whenever you encrypt your journal, you are asked whether you want to -store the encryption password in your keychain. If you do this, you -won’t have to enter your password every time you want to write or read -your journal. +## Storing Passwords in Your Keychain -If you don’t initially store the password in the keychain but decide to -do so at a later point – or maybe want to store it on one computer but -not on another – you can simply run `jrnl --encrypt` on an encrypted -journal and use the same password again. +Nobody can recover or reset your `jrnl` password. If you lose it, +your data will be inaccessible forever. -## A note on security +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. -While jrnl follows best practises, true security is an illusion. -Specifically, jrnl will leave traces in your memory and your shell -history – it’s meant to keep journals secure in transit, for example -when storing it on an -[untrusted](http://techcrunch.com/2014/04/09/condoleezza-rice-joins-dropboxs-board/) -services such as Dropbox. If you’re concerned about security, disable -history logging for journal in your `.bashrc`: +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. -``` sh -HISTIGNORE="$HISTIGNORE:jrnl *" -``` +## Manual Decryption -If you are using zsh instead of bash, you can get the same behaviour by -adding this to your `zshrc`: +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: -``` sh -setopt HIST_IGNORE_SPACE -alias jrnl=" jrnl" -``` +- **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 are using `fish` instead of `bash` or `zsh`, you can get the same behaviour by -adding this to your `fish` configuration: +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. -``` sh -abbr jrnl=" jrnl" -``` -To delete existing `jrnl` commands from `fish`’s history, run -`history delete --prefix 'jrnl '`. -## Manual decryption - -Should you ever want to decrypt your journal manually, you can do so -with any program that supports the AES algorithm in CBC. The key used -for encryption is the SHA-256-hash of your password, the IV -(initialisation vector) is stored in the first 16 bytes of the encrypted -file. The plain text is encoded in UTF-8 and padded according to PKCS\#7 -before being encrypted. Here’s a Python script that you can use to -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 -from Crypto.Cipher import AES import getpass import hashlib -import sys + +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() +key = hashlib.sha256(pwd.encode("utf-8")).digest() -with open(args.filepath, 'rb') as f: +with open(args.filepath, "rb") as f: ciphertext = f.read() crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16]) diff --git a/docs/export.md b/docs/export.md deleted file mode 100644 index f786a318..00000000 --- a/docs/export.md +++ /dev/null @@ -1,76 +0,0 @@ -# Import and Export - -## Tag export - -With - -``` sh -jrnl --tags -``` - -you'll get a list of all tags you used in your journal, sorted by most -frequent. Tags occurring several times in the same entry are only -counted as one. - -## List of all entries - -``` sh -jrnl --short -``` - -Will only display the date and title of each entry. - -## JSON export - -Can do - -``` sh -jrnl --export json -``` - -Why not create a [beautiful timeline](http://timeline.verite.co/) of -your journal? - -## Markdown export - -Use - -``` sh -jrnl --export markdown -``` - -Markdown is a simple markup language that is human readable and can be -used to be rendered to other formats (html, pdf). This README for -example is formatted in markdown and github makes it look nice. - -## Text export - -``` sh -jrnl --export text -``` - -Pretty-prints your entire journal. - -## Export to files - -You can specify the output file of your exported journal using the -`-o` argument - -``` sh -jrnl --export md -o journal.md -``` - -The above command will generate a file named `journal.md`. If the`-o` argument is a directory, jrnl will export each entry into an individual file - -``` sh -jrnl --export json -o my_entries/ -``` - -The contents of `my\_entries/` will then look like this: - -``` output -my_entries/ -|- 2013_06_03_a-beautiful-day.json -|- 2013_06_07_dinner-with-gabriel.json -|- ... -``` diff --git a/docs/external-editors.md b/docs/external-editors.md new file mode 100644 index 00000000..b7219d8d --- /dev/null +++ b/docs/external-editors.md @@ -0,0 +1,137 @@ + + +# 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. diff --git a/docs/formats.md b/docs/formats.md new file mode 100644 index 00000000..520a197c --- /dev/null +++ b/docs/formats.md @@ -0,0 +1,354 @@ + + +# 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 + + + + This is the first sample entry This is the sample body text of the first sample entry. + + + This is the second sample entry This is the sample body text of the second sample entry, but this one has a @tag. + + *This is the third sample entry, and is starred This is the sample body text of the third sample entry. + + + 1 + + +``` + +### 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 +|- ... +``` diff --git a/docs/installation.md b/docs/installation.md index 8bf29bb0..16401c73 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,19 +1,22 @@ + + # Getting started ## Installation -On OS X, the easiest way to install *jrnl* is using -[Homebrew](http://brew.sh/) +The easiest way to install `jrnl` is using +[pipx](https://pipx.pypa.io/stable/installation/) +with [Python](https://www.python.org/) 3.10+: ``` sh -brew install jrnl +pipx install jrnl ``` -On other platforms, install *jrnl* using pip - -``` sh -pip 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. @@ -22,8 +25,8 @@ should be created and whether you wish to encrypt it. To make a new entry, just type -``` sh -jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book. +``` 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. @@ -37,4 +40,4 @@ 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 *jrnl* to use your external editor. +but you can also [configure](advanced.md) *jrnl* to use your external editor. diff --git a/docs/journal-types.md b/docs/journal-types.md new file mode 100644 index 00000000..8f505215 --- /dev/null +++ b/docs/journal-types.md @@ -0,0 +1,65 @@ + + +# 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 confused with the DayOne 2.0 format, [which is very different](https://help.dayoneapp.com/en/articles/1187337-day-one-classic-is-retired). + +!!! note +DayOne Classic journals can't be encrypted. + +## Changing your journal type +You can't simply modify a journal's configuration to change its type. Instead, +define a new journal as the type you'd like, and use +[piping](https://en.wikipedia.org/wiki/Redirection_(computing)#Piping) +to export your old journal as `txt` to an import command on your new journal. + +For instance, if you have a `projects` journal you would like to import into +a `new` journal, you would run the following after setting up the configuration +for your `new` journal: +``` +jrnl projects --format txt | jrnl new --import +``` diff --git a/docs/overview.md b/docs/overview.md index 86211814..7b6cc310 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,27 +1,64 @@ + + # Overview -## What is jrnl? +`jrnl` is a simple journal application for the command line. -`jrnl` is a simple journal application for -your command line. Journals are stored as human readable plain text -files - you can put them into a Dropbox folder for instant syncing and -you can be assured that your journal will still be readable in 2050, -when all your fancy iPad journal applications will long be forgotten. +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). -Optionally, your journal can be encrypted using the [256-bit -AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). +`jrnl` has most of the features you need, and few of the ones you don't. -## Why keep a journal? +## Plain Text -Journals aren't just for people who have too much -time on their summer vacation. A journal helps you to keep track of the -things you get done and how you did them. Your imagination may be -limitless, but your memory isn't. +`jrnl` stores each journal in plain text. You can store `jrnl` files anywhere, +including in shared folders to keep them synchronized between devices. Journal +files are compact (thousands of entries take up less than 1 MiB) and can be read +by almost any electronic device, now and for the foreseeable future. -For personal use, make it a good habit to write at least 20 words a day. -Just to reflect what made this day special, why you haven't wasted it. +## Tags -For professional use, consider a text-based journal to be the perfect -complement to your GTD todo list - a documentation of what and how -you've done it. Or use it as a quick way to keep a change log. Or use it -to keep a lab book. +To make it easier to find entries later, `jrnl` includes support for inline tags +(the default tag symbol is `@`). You can find and filter entries by using tags +along with other search criteria. + +## Support for Multiple Journals + +`jrnl` includes support for the creation of multiple journals, each of which +can be stored as a single file or as a set of files. Entries are automatically +timestamped in a human-readable format that makes it easy to view multiple +entries at a time. `jrnl` can easily find the entries you want so that you can +read them or edit them. + +## Support for External Editors + +`jrnl` plays nicely with your favorite text editor. You may prefer to write +journal entries in an editor. Or you may want to make changes that require a +more comprehensive application. `jrnl` can filter specific entries and pass them +to the [external editor](./external-editors.md) of your choice. + +## Encryption + +`jrnl` includes support for [AES +encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). See the +[encryption page](./encryption.md) for more information. + +## Import and Export + +`jrnl` makes it easy to import entries from other sources. Existing entries can +be exported in a variety of [formats](./formats.md). + +## Multi-Platform Support + +`jrnl` is compatible with most operating systems. You can [download](./installation.md) it using one +of a variety of package managers, or you can build from source. + +## Open-Source + +`jrnl` is written in [Python](https://www.python.org) and maintained by a +[friendly community](https://github.com/jrnl-org/jrnl) of open-source software +enthusiasts. diff --git a/docs/privacy-and-security.md b/docs/privacy-and-security.md new file mode 100644 index 00000000..df19ea13 --- /dev/null +++ b/docs/privacy-and-security.md @@ -0,0 +1,232 @@ + + +# Privacy and Security + +`jrnl` is designed with privacy and security in mind, but like any other +program there are some limitations to be aware of. + +## Password strength + +`jrnl` doesn't enforce password strength requirements. Short or commonly-used +passwords can be easily circumvented by someone with basic security skills +to access to your encrypted `jrnl` file. + +## Plausible deniability + +You may be able to hide the contents of your journal behind a layer of encryption, +but if someone has access to your configuration file, then they can figure out that +you have a journal, where that journal file is, and when you last edited it. +With a sufficient power imbalance, someone may be able to force you to unencrypt +it through non-technical means. + +## Spying + +While `jrnl` can protect against unauthorized access to your journal entries while +it isn't open, it cannot protect you against an unsafe computer/location. +For example: + +- Someone installs a keylogger, tracking what you type into your journal. +- Someone watches your screen while you write your entry. +- Someone installs a backdoor into `jrnl` or poisons your journal into revealing your entries. + +## Saved Passwords + +When creating an encrypted journal, you'll be prompted as to whether or not you +want to "store the password in your keychain." This keychain is accessed using +the [Python keyring library](https://pypi.org/project/keyring/), which has different +behavior depending on your operating system. + +In Windows, the keychain is the Windows Credential Manager (WCM), which can't be locked +and can be accessed by any other application running under your username. If this is +a concern for you, you may not want to store your password. + +## Shell history + +Since you can enter entries from the command line, any tool that logs command +line actions is a potential security risk. See below for how to deal with this +problem in various shells. + +### bash + +You can disable history logging for jrnl by adding this line into your +`~/.bashrc` file: + +``` sh +HISTIGNORE="$HISTIGNORE:jrnl *" +``` + +To delete existing `jrnl` commands from `bash` history, simply delete them from +your bash history file. The default location of this file is `~/.bash_history`, +but you can run `echo "$HISTFILE"` to find it if needed. Also, you can run +`history -c` to delete all commands from your history. + +### zsh + +You can disable history logging for jrnl by adding this to your `~/.zshrc` +file: + +``` sh +setopt HIST_IGNORE_SPACE +alias jrnl=" jrnl" +``` + +To delete existing `jrnl` commands from `zsh` history, simply remove them from +your zsh history file. The default location of this file is `~/.zsh_history`, +but you can run `echo "$HISTFILE"` to find it if needed. Also, you can run +`history -c` to delete all commands from your history. + +### fish + +By default `fish` will not log any command that starts with a space. If you +want to always run jrnl with a space before it, then you can add this to your +`~/.config/fish/config.fish` file: + +``` sh +abbr --add jrnl " jrnl" +``` + +To delete existing jrnl commands from `fish` history, run `history delete --prefix 'jrnl '`. + +### Windows Command Prompt + +Windows doesn't log history to disk, but it does keep it in your command prompt +session. Close the command prompt or press `Alt`+`F7` to clear your history +after journaling. + +## Files in transit from editor to jrnl + +When creating or editing an entry, `jrnl` uses a unencrypted temporary file on +disk in order to give your editor access to your journal. After you close your +editor, `jrnl` then deletes this temporary file. + +So, if you have saved a journal entry but haven't closed your editor yet, the +unencrypted temporary remains on your disk. If your computer were to shut off +during this time, or the `jrnl` process were killed unexpectedly, then the +unencrypted temporary file will remain on your disk. You can mitigate this +issue by only saving with your editor right before closing it. You can also +manually delete these files from your temporary folder. By default, they +are named `jrnl*.jrnl`, but if you use a +[template](reference-config-file.md#template), they will have the same +extension as the template. + +## Editor history + +Some editors keep usage history stored on disk for future use. This can be a +security risk in the sense that sensitive information can leak via recent +search patterns or editor commands. + +### Visual Studio Code + +Visual Studio Code stores the contents of saved files to allow you to restore or +review the contents later. You can disable this feature for all files by unchecking +the `workbench.localHistory.enabled` setting in the +[Settings editor](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor). + +Alternatively, you can disable this feature for specific files by configuring a +[pattern](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options) +in the `workbench.localHistory.exclude` setting. To exclude unencrypted temporary files generated +by `jrnl`, you can set the `**/jrnl*.jrnl` (unless you are using a +[template](reference-config-file.md#template)) pattern for the `workbench.localHistory.exclude` setting +in the [Settings editor](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor). + +!!! note + On Windows, the history location is typically found at + `%APPDATA%\Code\User\History`. + +Visual Studio Code also creates a copy of all unsaved files that are open. +It stores these copies in a backup location that's automatically cleaned when +you save the file. However, if your computer shuts off before you save the file, +or the Visual Studio Code process stops unexpectedly, then an unencrypted +temporary file may remain on your disk. You can manually delete these files +from the backup location. + +!!! note + On Windows, the backup location is typically found at + `%APPDATA%\Code\Backups`. + +### Vim + +Vim stores progress data in a so called Viminfo file located at `~/.viminfo` +which contains all sorts of user data including command line history, search +string history, search/substitute patterns, contents of register etc. Also to +be able to recover opened files after an unexpected application close Vim uses +swap files. + +These options as well as other leaky features can be disabled by setting the +`editor` key in the Jrnl settings like this: + +``` yaml +editor: "vim -c 'set viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'" +``` + +To disable all plugins and custom configurations and start Vim with the default +configuration `-u NONE` can be passed on the command line as well. This will +ensure that any rogue plugins or other difficult to catch information leaks are +eliminated. The downside to this is that the editor experience will decrease +quite a bit. + +To instead let Vim automatically detect when a Jrnl file is being edited an +autocommand can be used. Place this in your `~/.vimrc`: + +``` vim +autocmd BufNewFile,BufReadPre *.jrnl setlocal viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure +``` + +!!! note + If you're using a [template](reference-config-file.md#template), you will + have to use the template's file extension instead of `.jrnl`. + +See `:h