From f5e052937c828cf4023c488ef36788c005b94094 Mon Sep 17 00:00:00 2001 From: Jonathan Wren Date: Sat, 18 Jun 2022 11:30:56 -0700 Subject: [PATCH 1/4] Update copyright year (#1502) Update copyright year in comment headers and --version output --- .github/workflows/changelog.yaml | 3 +++ .github/workflows/docs.yaml | 3 +++ .github/workflows/release.yaml | 3 +++ .github/workflows/testing_prs.yaml | 3 +++ .github/workflows/testing_schedule.yaml | 3 +++ CONTRIBUTING.md | 7 +++++-- README.md | 5 +++++ docs/advanced.md | 6 ++++-- docs/contributing.md | 7 +++++-- docs/encryption.md | 7 +++++-- docs/external-editors.md | 5 +++++ docs/formats.md | 7 +++++-- docs/installation.md | 7 +++++-- docs/journal-types.md | 7 +++++-- docs/overview.md | 7 +++++-- docs/privacy-and-security.md | 7 +++++-- docs/reference-command-line.md | 5 +++++ docs/reference-config-file.md | 5 +++++ docs/tips-and-tricks.md | 7 +++++-- docs/usage.md | 7 +++++-- docs_theme/assets/colors.css | 6 ++++-- docs_theme/assets/highlight.css | 3 +++ docs_theme/assets/index.css | 7 +++++-- docs_theme/assets/theme.css | 6 ++++-- docs_theme/index.html | 7 +++++-- docs_theme/main.html | 5 +++++ docs_theme/search.html | 5 +++++ jrnl/DayOneJournal.py | 3 +++ jrnl/EncryptedJournal.py | 3 +++ jrnl/Entry.py | 3 +-- jrnl/FolderJournal.py | 4 +--- jrnl/Journal.py | 3 +-- jrnl/__init__.py | 2 +- jrnl/__main__.py | 2 +- jrnl/args.py | 2 +- jrnl/cli.py | 2 +- jrnl/color.py | 3 +++ jrnl/commands.py | 5 ++++- jrnl/config.py | 3 +++ jrnl/editor.py | 3 +++ jrnl/exception.py | 3 ++- jrnl/install.py | 3 +-- jrnl/jrnl.py | 2 +- jrnl/messages/Message.py | 3 +++ jrnl/messages/MsgStyle.py | 3 +++ jrnl/messages/MsgText.py | 3 +++ jrnl/messages/__init__.py | 3 +++ jrnl/os_compat.py | 2 +- jrnl/output.py | 3 ++- jrnl/override.py | 3 +++ jrnl/path.py | 3 +++ jrnl/plugins/__init__.py | 3 +-- jrnl/plugins/dates_exporter.py | 4 ++-- jrnl/plugins/fancy_exporter.py | 3 +-- jrnl/plugins/jrnl_importer.py | 3 +-- jrnl/plugins/json_exporter.py | 3 +-- jrnl/plugins/markdown_exporter.py | 3 +-- jrnl/plugins/tag_exporter.py | 3 +-- jrnl/plugins/text_exporter.py | 3 +-- jrnl/plugins/util.py | 3 +-- jrnl/plugins/xml_exporter.py | 3 +-- jrnl/plugins/yaml_exporter.py | 3 +-- jrnl/prompt.py | 3 ++- jrnl/time.py | 2 +- jrnl/upgrade.py | 2 +- tests/bdd/features/build.feature | 3 +++ tests/bdd/features/change_time.feature | 3 +++ tests/bdd/features/config_file.feature | 3 +++ tests/bdd/features/core.feature | 3 +++ tests/bdd/features/datetime.feature | 3 +++ tests/bdd/features/delete.feature | 3 +++ tests/bdd/features/encrypt.feature | 3 +++ tests/bdd/features/file_storage.feature | 3 +++ tests/bdd/features/format.feature | 3 +++ tests/bdd/features/import.feature | 3 +++ tests/bdd/features/multiple_journals.feature | 3 +++ tests/bdd/features/override.feature | 3 +++ tests/bdd/features/password.feature | 3 +++ tests/bdd/features/search.feature | 3 +++ tests/bdd/features/star.feature | 3 +++ tests/bdd/features/tag.feature | 3 +++ tests/bdd/features/upgrade.feature | 3 +++ tests/bdd/features/write.feature | 3 +++ tests/bdd/test_features.py | 3 +++ tests/conftest.py | 2 +- tests/lib/fixtures.py | 2 +- tests/lib/given_steps.py | 2 +- tests/lib/helpers.py | 2 +- tests/lib/then_steps.py | 2 +- tests/lib/when_steps.py | 2 +- tests/unit/test_color.py | 3 +++ tests/unit/test_config_file.py | 3 +++ tests/unit/test_export.py | 3 +++ tests/unit/test_install.py | 3 +++ tests/unit/test_jrnl.py | 3 +++ tests/unit/test_os_compat.py | 3 +++ tests/unit/test_output.py | 3 ++- tests/unit/test_override.py | 3 +++ tests/unit/test_parse_args.py | 3 +++ tests/unit/test_path.py | 3 +++ tests/unit/test_time.py | 3 +++ 101 files changed, 282 insertions(+), 80 deletions(-) diff --git a/.github/workflows/changelog.yaml b/.github/workflows/changelog.yaml index c8d184ec..b6dc9139 100644 --- a/.github/workflows/changelog.yaml +++ b/.github/workflows/changelog.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + name: Changelog on: diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index ac85f2c0..c4b6ef43 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + name: Docs on: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 5e0169c1..3eb8c8f4 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + name: Release on: workflow_dispatch: diff --git a/.github/workflows/testing_prs.yaml b/.github/workflows/testing_prs.yaml index b5514f19..27126df8 100644 --- a/.github/workflows/testing_prs.yaml +++ b/.github/workflows/testing_prs.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + name: Testing on: diff --git a/.github/workflows/testing_schedule.yaml b/.github/workflows/testing_schedule.yaml index 44dd0b69..fd38cd41 100644 --- a/.github/workflows/testing_schedule.yaml +++ b/.github/workflows/testing_schedule.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + name: Testing on: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93b57d7e..bd00f6e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,8 @@ - + + # Contributing See "[Contributing](docs/contributing.md)" in the `docs` directory. diff --git a/README.md b/README.md index cacd8dda..e2809a0f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + +

diff --git a/docs/advanced.md b/docs/advanced.md index c0b1195c..61529fc4 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -1,5 +1,7 @@ - + # Advanced Usage diff --git a/docs/contributing.md b/docs/contributing.md index b12ce7be..ea651df5 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,5 +1,8 @@ - + + # 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. diff --git a/docs/encryption.md b/docs/encryption.md index 06217f01..e8b86e62 100644 --- a/docs/encryption.md +++ b/docs/encryption.md @@ -1,5 +1,8 @@ - + + # Encryption ## A Note on Security diff --git a/docs/external-editors.md b/docs/external-editors.md index 8797325a..efa0b55c 100644 --- a/docs/external-editors.md +++ b/docs/external-editors.md @@ -1,3 +1,8 @@ + + # External editors Configure your preferred external editor by updating the `editor` option diff --git a/docs/formats.md b/docs/formats.md index 99b3e69b..a87c4e8a 100644 --- a/docs/formats.md +++ b/docs/formats.md @@ -1,5 +1,8 @@ - + + # Formats `jrnl` supports a variety of alternate formats. These can be used to display your diff --git a/docs/installation.md b/docs/installation.md index a37e21fd..4d2c4c97 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,8 @@ - + + # Getting started ## Installation diff --git a/docs/journal-types.md b/docs/journal-types.md index 65efc143..b2ec78da 100644 --- a/docs/journal-types.md +++ b/docs/journal-types.md @@ -1,5 +1,8 @@ - + + # Journal Types `jrnl` can store your journal in a few different ways: diff --git a/docs/overview.md b/docs/overview.md index 57269585..b20c85f9 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,5 +1,8 @@ - + + # Overview `jrnl` is a simple journal application for the command line. diff --git a/docs/privacy-and-security.md b/docs/privacy-and-security.md index c2996d25..9030df99 100644 --- a/docs/privacy-and-security.md +++ b/docs/privacy-and-security.md @@ -1,5 +1,8 @@ - + + # Privacy and Security `jrnl` is designed with privacy and security in mind, but like any other diff --git a/docs/reference-command-line.md b/docs/reference-command-line.md index bc624fe5..149ae26f 100644 --- a/docs/reference-command-line.md +++ b/docs/reference-command-line.md @@ -1,3 +1,8 @@ + + # Command Line Reference ## Synopsis diff --git a/docs/reference-config-file.md b/docs/reference-config-file.md index 97ec290c..03454c05 100644 --- a/docs/reference-config-file.md +++ b/docs/reference-config-file.md @@ -1,3 +1,8 @@ + + # Configuration File Reference `jrnl` stores its information in a YAML configuration file. diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md index a158916c..c4531798 100644 --- a/docs/tips-and-tricks.md +++ b/docs/tips-and-tricks.md @@ -1,5 +1,8 @@ - + + # Tips and Tricks This page contains tips and tricks for using `jrnl`, often in conjunction diff --git a/docs/usage.md b/docs/usage.md index 1a4de2a2..9e8c3ee3 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,5 +1,8 @@ - + + # Basic Usage # `jrnl` has two modes: **composing** and **viewing**. Whenever you don't enter diff --git a/docs_theme/assets/colors.css b/docs_theme/assets/colors.css index 93d84b4d..3f8b46a8 100644 --- a/docs_theme/assets/colors.css +++ b/docs_theme/assets/colors.css @@ -1,5 +1,7 @@ -/* Copyright (C) 2012-2021 jrnl contributors - License: https://www.gnu.org/licenses/gpl-3.0.html */ +/* +Copyright (C) 2012-2022 jrnl contributors +License: https://www.gnu.org/licenses/gpl-3.0.html +*/ :root { /* For dark bg */ diff --git a/docs_theme/assets/highlight.css b/docs_theme/assets/highlight.css index b7052917..27950c0f 100644 --- a/docs_theme/assets/highlight.css +++ b/docs_theme/assets/highlight.css @@ -1,4 +1,7 @@ /* +Copyright (C) 2012-2022 jrnl contributors +License: https://www.gnu.org/licenses/gpl-3.0.html + Atom One Dark With support for ReasonML by Gidi Morris, based off work by Daniel Gamage diff --git a/docs_theme/assets/index.css b/docs_theme/assets/index.css index a7ed63ee..d6e834e3 100644 --- a/docs_theme/assets/index.css +++ b/docs_theme/assets/index.css @@ -1,5 +1,8 @@ -/* Copyright (C) 2012-2021 jrnl contributors - License: https://www.gnu.org/licenses/gpl-3.0.html */ +/* +Copyright (C) 2012-2022 jrnl contributors +License: https://www.gnu.org/licenses/gpl-3.0.html +*/ + /* reset */article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}audio,canvas,video{display:inline-block}audio:not([controls]){display:none;height:0}[hidden]{display:none}html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}a:focus{outline:thin dotted}a:active,a:hover{outline:0}h1{font-size:2em;margin:.67em 0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}mark{background:#ff0;color:#000}code,kbd,pre,samp{font-family:monospace,serif;font-size:1em}pre{white-space:pre-wrap}q{quotes:"\201C" "\201D" "\2018" "\2019"}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:0}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}button,input{line-height:normal}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top}table{border-collapse:collapse;border-spacing:0} body { diff --git a/docs_theme/assets/theme.css b/docs_theme/assets/theme.css index 20c4cd89..152e0521 100644 --- a/docs_theme/assets/theme.css +++ b/docs_theme/assets/theme.css @@ -1,5 +1,7 @@ -/* Copyright (C) 2012-2021 jrnl contributors - License: https://www.gnu.org/licenses/gpl-3.0.html */ +/* +Copyright (C) 2012-2022 jrnl contributors +License: https://www.gnu.org/licenses/gpl-3.0.html +*/ /* ------------------------------------------------------------ */ /* Overrides for jrnl theme */ diff --git a/docs_theme/index.html b/docs_theme/index.html index b21493d2..57c90c76 100644 --- a/docs_theme/index.html +++ b/docs_theme/index.html @@ -1,5 +1,8 @@ - + + diff --git a/docs_theme/main.html b/docs_theme/main.html index 18a4f1cf..7849dd02 100644 --- a/docs_theme/main.html +++ b/docs_theme/main.html @@ -1,3 +1,8 @@ + + {% extends "base.html" %} {%- block search_button %} diff --git a/docs_theme/search.html b/docs_theme/search.html index b191fc2a..37bcfe5d 100644 --- a/docs_theme/search.html +++ b/docs_theme/search.html @@ -1,3 +1,8 @@ + + {% extends "main.html" %} {% block content %} diff --git a/jrnl/DayOneJournal.py b/jrnl/DayOneJournal.py index 1e484365..8034e36b 100644 --- a/jrnl/DayOneJournal.py +++ b/jrnl/DayOneJournal.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import datetime import fnmatch import os diff --git a/jrnl/EncryptedJournal.py b/jrnl/EncryptedJournal.py index fb4ba5ce..e2aec8ed 100644 --- a/jrnl/EncryptedJournal.py +++ b/jrnl/EncryptedJournal.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import base64 import hashlib import logging diff --git a/jrnl/Entry.py b/jrnl/Entry.py index 800345c6..323eef73 100644 --- a/jrnl/Entry.py +++ b/jrnl/Entry.py @@ -1,7 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html - import datetime import re diff --git a/jrnl/FolderJournal.py b/jrnl/FolderJournal.py index a381c872..b5cf2e71 100644 --- a/jrnl/FolderJournal.py +++ b/jrnl/FolderJournal.py @@ -1,8 +1,6 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html - import codecs import fnmatch import os diff --git a/jrnl/Journal.py b/jrnl/Journal.py index b2e5383b..301bba76 100644 --- a/jrnl/Journal.py +++ b/jrnl/Journal.py @@ -1,7 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html - import datetime import logging import os diff --git a/jrnl/__init__.py b/jrnl/__init__.py index 550d580f..2fc7e3bf 100644 --- a/jrnl/__init__.py +++ b/jrnl/__init__.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html try: diff --git a/jrnl/__main__.py b/jrnl/__main__.py index 49497161..06ffedaa 100644 --- a/jrnl/__main__.py +++ b/jrnl/__main__.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import sys diff --git a/jrnl/args.py b/jrnl/args.py index 1f3e3c9a..5fd8e370 100644 --- a/jrnl/args.py +++ b/jrnl/args.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import argparse diff --git a/jrnl/cli.py b/jrnl/cli.py index 305e4502..e81fb1ce 100644 --- a/jrnl/cli.py +++ b/jrnl/cli.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import logging diff --git a/jrnl/color.py b/jrnl/color.py index 7cc8df2f..7268d773 100644 --- a/jrnl/color.py +++ b/jrnl/color.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import re from string import punctuation from string import whitespace diff --git a/jrnl/commands.py b/jrnl/commands.py index 7ef9f09c..dd2ce52b 100644 --- a/jrnl/commands.py +++ b/jrnl/commands.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + """ Functions in this file are standalone commands. All standalone commands are split into two categories depending on whether they require the config to be loaded to be able to @@ -38,7 +41,7 @@ def preconfig_version(_): version_str = f"""{__title__} version {__version__} -Copyright (C) 2012-2021 jrnl contributors +Copyright (C) 2012-2022 jrnl contributors This is free software, and you are welcome to redistribute it under certain conditions; for details, see: https://www.gnu.org/licenses/gpl-3.0.html""" diff --git a/jrnl/config.py b/jrnl/config.py index c9b860bb..40746d3e 100644 --- a/jrnl/config.py +++ b/jrnl/config.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import logging import os diff --git a/jrnl/editor.py b/jrnl/editor.py index 91aa4d52..a6bff5d3 100644 --- a/jrnl/editor.py +++ b/jrnl/editor.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import logging import os import subprocess diff --git a/jrnl/exception.py b/jrnl/exception.py index fdfa61a4..6dfc6593 100644 --- a/jrnl/exception.py +++ b/jrnl/exception.py @@ -1,5 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html + from jrnl.messages import Message from jrnl.output import print_msg diff --git a/jrnl/install.py b/jrnl/install.py index 88663d58..a7dc6318 100644 --- a/jrnl/install.py +++ b/jrnl/install.py @@ -1,7 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html - import glob import logging import os diff --git a/jrnl/jrnl.py b/jrnl/jrnl.py index 18ee4ed4..2c5fafae 100644 --- a/jrnl/jrnl.py +++ b/jrnl/jrnl.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import logging diff --git a/jrnl/messages/Message.py b/jrnl/messages/Message.py index 2c02e8a0..86809192 100644 --- a/jrnl/messages/Message.py +++ b/jrnl/messages/Message.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from typing import NamedTuple from typing import Mapping diff --git a/jrnl/messages/MsgStyle.py b/jrnl/messages/MsgStyle.py index 41daa535..b8e15316 100644 --- a/jrnl/messages/MsgStyle.py +++ b/jrnl/messages/MsgStyle.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from enum import Enum from typing import NamedTuple from typing import Callable diff --git a/jrnl/messages/MsgText.py b/jrnl/messages/MsgText.py index f8e85b60..8de0d518 100644 --- a/jrnl/messages/MsgText.py +++ b/jrnl/messages/MsgText.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from enum import Enum diff --git a/jrnl/messages/__init__.py b/jrnl/messages/__init__.py index 930fbe75..f2eaec4c 100644 --- a/jrnl/messages/__init__.py +++ b/jrnl/messages/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from .Message import Message from .MsgStyle import MsgStyle from .MsgText import MsgText diff --git a/jrnl/os_compat.py b/jrnl/os_compat.py index 6615b886..1ede4534 100644 --- a/jrnl/os_compat.py +++ b/jrnl/os_compat.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import shlex diff --git a/jrnl/output.py b/jrnl/output.py index fb21990b..3eae32cc 100644 --- a/jrnl/output.py +++ b/jrnl/output.py @@ -1,5 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html + import textwrap from typing import Union diff --git a/jrnl/override.py b/jrnl/override.py index 760b003e..6ef378f4 100644 --- a/jrnl/override.py +++ b/jrnl/override.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from .config import update_config, make_yaml_valid_dict from argparse import Namespace diff --git a/jrnl/path.py b/jrnl/path.py index bb465d6e..cf13a2a8 100644 --- a/jrnl/path.py +++ b/jrnl/path.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import os.path diff --git a/jrnl/plugins/__init__.py b/jrnl/plugins/__init__.py index e3484927..f994e4fc 100644 --- a/jrnl/plugins/__init__.py +++ b/jrnl/plugins/__init__.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from .fancy_exporter import FancyExporter diff --git a/jrnl/plugins/dates_exporter.py b/jrnl/plugins/dates_exporter.py index e032b652..c1c8fd0a 100644 --- a/jrnl/plugins/dates_exporter.py +++ b/jrnl/plugins/dates_exporter.py @@ -1,6 +1,6 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html + from collections import Counter from .text_exporter import TextExporter diff --git a/jrnl/plugins/fancy_exporter.py b/jrnl/plugins/fancy_exporter.py index 0c440e96..cdbd4b08 100644 --- a/jrnl/plugins/fancy_exporter.py +++ b/jrnl/plugins/fancy_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from jrnl.exception import JrnlException diff --git a/jrnl/plugins/jrnl_importer.py b/jrnl/plugins/jrnl_importer.py index cfdee0d7..0468b476 100644 --- a/jrnl/plugins/jrnl_importer.py +++ b/jrnl/plugins/jrnl_importer.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import sys diff --git a/jrnl/plugins/json_exporter.py b/jrnl/plugins/json_exporter.py index 666d9a3d..abce6f50 100644 --- a/jrnl/plugins/json_exporter.py +++ b/jrnl/plugins/json_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import json diff --git a/jrnl/plugins/markdown_exporter.py b/jrnl/plugins/markdown_exporter.py index 63be85e0..30614746 100644 --- a/jrnl/plugins/markdown_exporter.py +++ b/jrnl/plugins/markdown_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import os diff --git a/jrnl/plugins/tag_exporter.py b/jrnl/plugins/tag_exporter.py index 1153fa01..9c2b7fb5 100644 --- a/jrnl/plugins/tag_exporter.py +++ b/jrnl/plugins/tag_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from .text_exporter import TextExporter diff --git a/jrnl/plugins/text_exporter.py b/jrnl/plugins/text_exporter.py index d82a1e40..55c0d83a 100644 --- a/jrnl/plugins/text_exporter.py +++ b/jrnl/plugins/text_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import os diff --git a/jrnl/plugins/util.py b/jrnl/plugins/util.py index ae49a2a8..a2188306 100644 --- a/jrnl/plugins/util.py +++ b/jrnl/plugins/util.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html diff --git a/jrnl/plugins/xml_exporter.py b/jrnl/plugins/xml_exporter.py index 9901f4b7..10050b50 100644 --- a/jrnl/plugins/xml_exporter.py +++ b/jrnl/plugins/xml_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from xml.dom import minidom diff --git a/jrnl/plugins/yaml_exporter.py b/jrnl/plugins/yaml_exporter.py index f78c781b..00a4613b 100644 --- a/jrnl/plugins/yaml_exporter.py +++ b/jrnl/plugins/yaml_exporter.py @@ -1,5 +1,4 @@ -# encoding: utf-8 -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import os diff --git a/jrnl/prompt.py b/jrnl/prompt.py index 843e7425..4cd38d90 100644 --- a/jrnl/prompt.py +++ b/jrnl/prompt.py @@ -1,5 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html + from jrnl.messages import Message from jrnl.messages import MsgText from jrnl.messages import MsgStyle diff --git a/jrnl/time.py b/jrnl/time.py index f4e7319d..c457c12b 100644 --- a/jrnl/time.py +++ b/jrnl/time.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import datetime diff --git a/jrnl/upgrade.py b/jrnl/upgrade.py index 5c033534..29ff8eb4 100644 --- a/jrnl/upgrade.py +++ b/jrnl/upgrade.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import os diff --git a/tests/bdd/features/build.feature b/tests/bdd/features/build.feature index e9b47b49..d2f5e950 100644 --- a/tests/bdd/features/build.feature +++ b/tests/bdd/features/build.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Build process Scenario: Version numbers should stay in sync diff --git a/tests/bdd/features/change_time.feature b/tests/bdd/features/change_time.feature index bd8e77f7..7f4a08e3 100644 --- a/tests/bdd/features/change_time.feature +++ b/tests/bdd/features/change_time.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Change entry times in journal Scenario Outline: Change time flag changes single entry timestamp Given we use the config "" diff --git a/tests/bdd/features/config_file.feature b/tests/bdd/features/config_file.feature index 168cd7aa..76e93059 100644 --- a/tests/bdd/features/config_file.feature +++ b/tests/bdd/features/config_file.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Multiple journals Scenario: Read a journal from an alternate config diff --git a/tests/bdd/features/core.feature b/tests/bdd/features/core.feature index 4399341d..7b8de194 100644 --- a/tests/bdd/features/core.feature +++ b/tests/bdd/features/core.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Functionality of jrnl outside of actually handling journals Scenario: Displaying the version number diff --git a/tests/bdd/features/datetime.feature b/tests/bdd/features/datetime.feature index 1b9d00b9..28d63169 100644 --- a/tests/bdd/features/datetime.feature +++ b/tests/bdd/features/datetime.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Reading and writing to journal with custom date formats Scenario: Dates can include a time diff --git a/tests/bdd/features/delete.feature b/tests/bdd/features/delete.feature index fe323966..806abb18 100644 --- a/tests/bdd/features/delete.feature +++ b/tests/bdd/features/delete.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Delete entries from journal Scenario Outline: Delete flag allows deletion of single entry Given we use the config "" diff --git a/tests/bdd/features/encrypt.feature b/tests/bdd/features/encrypt.feature index 09a80bcc..16c8855c 100644 --- a/tests/bdd/features/encrypt.feature +++ b/tests/bdd/features/encrypt.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Encrypting and decrypting journals Scenario: Decrypting a journal diff --git a/tests/bdd/features/file_storage.feature b/tests/bdd/features/file_storage.feature index 5cb6ba45..0e54f620 100644 --- a/tests/bdd/features/file_storage.feature +++ b/tests/bdd/features/file_storage.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Journals iteracting with the file system in a way that users can see Scenario: Adding entries to a Folder journal should generate date files diff --git a/tests/bdd/features/format.feature b/tests/bdd/features/format.feature index ce29a016..9781ff51 100644 --- a/tests/bdd/features/format.feature +++ b/tests/bdd/features/format.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Custom formats Scenario Outline: Short printing via --format flag diff --git a/tests/bdd/features/import.feature b/tests/bdd/features/import.feature index 920cddf2..3872702e 100644 --- a/tests/bdd/features/import.feature +++ b/tests/bdd/features/import.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Importing data Scenario Outline: --import allows new entry from stdin diff --git a/tests/bdd/features/multiple_journals.feature b/tests/bdd/features/multiple_journals.feature index 09bd71fd..642149ca 100644 --- a/tests/bdd/features/multiple_journals.feature +++ b/tests/bdd/features/multiple_journals.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Multiple journals Scenario: Loading a config with two journals diff --git a/tests/bdd/features/override.feature b/tests/bdd/features/override.feature index 90b7e40b..9af459f3 100644 --- a/tests/bdd/features/override.feature +++ b/tests/bdd/features/override.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Implementing Runtime Overrides for Select Configuration Keys Scenario: Override configured editor with built-in input === editor:'' diff --git a/tests/bdd/features/password.feature b/tests/bdd/features/password.feature index 23a08aab..cf00f85c 100644 --- a/tests/bdd/features/password.feature +++ b/tests/bdd/features/password.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Using the installed keyring Scenario: Storing a password in keyring diff --git a/tests/bdd/features/search.feature b/tests/bdd/features/search.feature index 60b4fefb..239f74d5 100644 --- a/tests/bdd/features/search.feature +++ b/tests/bdd/features/search.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Searching in a journal Scenario Outline: Displaying entries using -on today should display entries created today diff --git a/tests/bdd/features/star.feature b/tests/bdd/features/star.feature index f59a7ecc..825ee2fa 100644 --- a/tests/bdd/features/star.feature +++ b/tests/bdd/features/star.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Starring entries Scenario Outline: Starring an entry will mark it in the journal file diff --git a/tests/bdd/features/tag.feature b/tests/bdd/features/tag.feature index a62b5ac8..1d762431 100644 --- a/tests/bdd/features/tag.feature +++ b/tests/bdd/features/tag.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Tagging # See search.feature for tag-related searches # And format.feature for tag-related output diff --git a/tests/bdd/features/upgrade.feature b/tests/bdd/features/upgrade.feature index c092dedb..5e53130a 100644 --- a/tests/bdd/features/upgrade.feature +++ b/tests/bdd/features/upgrade.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Upgrading Journals from 1.x.x to 2.x.x Scenario: Upgrade and parse journals with square brackets diff --git a/tests/bdd/features/write.feature b/tests/bdd/features/write.feature index ede1934b..fe0573ff 100644 --- a/tests/bdd/features/write.feature +++ b/tests/bdd/features/write.feature @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + Feature: Writing new entries. Scenario Outline: Multiline entry with punctuation should keep title punctuation diff --git a/tests/bdd/test_features.py b/tests/bdd/test_features.py index 04f9d46f..fda146e1 100644 --- a/tests/bdd/test_features.py +++ b/tests/bdd/test_features.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from pytest_bdd import scenarios scenarios("features/build.feature") diff --git a/tests/conftest.py b/tests/conftest.py index c4dc5ef5..ed85affa 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from pytest import mark diff --git a/tests/lib/fixtures.py b/tests/lib/fixtures.py index 6fc7cc2a..1ad17708 100644 --- a/tests/lib/fixtures.py +++ b/tests/lib/fixtures.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from collections import defaultdict diff --git a/tests/lib/given_steps.py b/tests/lib/given_steps.py index 4b545849..6da84643 100644 --- a/tests/lib/given_steps.py +++ b/tests/lib/given_steps.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from datetime import datetime diff --git a/tests/lib/helpers.py b/tests/lib/helpers.py index ad68cde3..39a24f71 100644 --- a/tests/lib/helpers.py +++ b/tests/lib/helpers.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import functools diff --git a/tests/lib/then_steps.py b/tests/lib/then_steps.py index 5ec83d3c..08d8ddc7 100644 --- a/tests/lib/then_steps.py +++ b/tests/lib/then_steps.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html import json diff --git a/tests/lib/when_steps.py b/tests/lib/when_steps.py index bc1d742d..759c708d 100644 --- a/tests/lib/when_steps.py +++ b/tests/lib/when_steps.py @@ -1,4 +1,4 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html from contextlib import ExitStack diff --git a/tests/unit/test_color.py b/tests/unit/test_color.py index 527b8e89..800d619a 100644 --- a/tests/unit/test_color.py +++ b/tests/unit/test_color.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from colorama import Fore from colorama import Style import pytest diff --git a/tests/unit/test_config_file.py b/tests/unit/test_config_file.py index f9cdb7ec..0ffb3b38 100644 --- a/tests/unit/test_config_file.py +++ b/tests/unit/test_config_file.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import pytest import os diff --git a/tests/unit/test_export.py b/tests/unit/test_export.py index 1ca8856f..c5137794 100644 --- a/tests/unit/test_export.py +++ b/tests/unit/test_export.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import pytest from jrnl.exception import JrnlException diff --git a/tests/unit/test_install.py b/tests/unit/test_install.py index bc36b927..8e5db8df 100644 --- a/tests/unit/test_install.py +++ b/tests/unit/test_install.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import sys from unittest import mock diff --git a/tests/unit/test_jrnl.py b/tests/unit/test_jrnl.py index f87f6dad..247a9fd1 100644 --- a/tests/unit/test_jrnl.py +++ b/tests/unit/test_jrnl.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from unittest import mock import pytest diff --git a/tests/unit/test_os_compat.py b/tests/unit/test_os_compat.py index 02d54716..2a3b0b14 100644 --- a/tests/unit/test_os_compat.py +++ b/tests/unit/test_os_compat.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + from unittest import mock import pytest diff --git a/tests/unit/test_output.py b/tests/unit/test_output.py index 0fa9f45b..e93ec44a 100644 --- a/tests/unit/test_output.py +++ b/tests/unit/test_output.py @@ -1,5 +1,6 @@ -# Copyright (C) 2012-2021 jrnl contributors +# Copyright (C) 2012-2022 jrnl contributors # License: https://www.gnu.org/licenses/gpl-3.0.html + from unittest.mock import Mock from unittest.mock import patch diff --git a/tests/unit/test_override.py b/tests/unit/test_override.py index 2719e884..438ae03b 100644 --- a/tests/unit/test_override.py +++ b/tests/unit/test_override.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import pytest from jrnl.override import _convert_dots_to_list diff --git a/tests/unit/test_parse_args.py b/tests/unit/test_parse_args.py index 7acae571..6c187576 100644 --- a/tests/unit/test_parse_args.py +++ b/tests/unit/test_parse_args.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import shlex import pytest diff --git a/tests/unit/test_path.py b/tests/unit/test_path.py index a13b89e5..efc6e54d 100644 --- a/tests/unit/test_path.py +++ b/tests/unit/test_path.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import pytest import random import string diff --git a/tests/unit/test_time.py b/tests/unit/test_time.py index 5f22148e..8bed5f86 100644 --- a/tests/unit/test_time.py +++ b/tests/unit/test_time.py @@ -1,3 +1,6 @@ +# Copyright (C) 2012-2022 jrnl contributors +# License: https://www.gnu.org/licenses/gpl-3.0.html + import datetime from jrnl import time From c1c70e643ab0b7db3e5a69d7cae9e38595b2e07a Mon Sep 17 00:00:00 2001 From: Jrnl Bot Date: Sat, 18 Jun 2022 18:32:43 +0000 Subject: [PATCH 2/4] Update changelog [ci skip] --- CHANGELOG.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 136eb49a..01522eaa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## [Unreleased](https://github.com/jrnl-org/jrnl/) + +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.0-beta...HEAD) + +**Fixed bugs:** + +- Adding new entry with date only works with format m.d.Y [\#1509](https://github.com/jrnl-org/jrnl/issues/1509) + +**Build:** + +- Update copyright year [\#1502](https://github.com/jrnl-org/jrnl/pull/1502) ([wren](https://github.com/wren)) + ## [v3.0-beta](https://pypi.org/project/jrnl/v3.0-beta/) (2022-06-11) [Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.8.4...v3.0-beta) From 51ab747019b0a6d4a4e2b01e7c03eb03363ba4c7 Mon Sep 17 00:00:00 2001 From: Jonathan Wren Date: Sat, 18 Jun 2022 11:36:56 -0700 Subject: [PATCH 3/4] Replace `make` with python alternative (`poe`) (#1503) * Get rid of `make` in favor of `poe` This moves the tasks that were previously in Makefile, into pyproject.toml (with all the other config) This is also more inclusive of Windows developers since they only need Python, and no longer have to install make separately. * udpate docs * don't make code blocks also links --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- Makefile | 39 -------------------------------- docs/contributing.md | 16 ++++++++----- poetry.lock | 39 ++++++++++++++++++++++++++++---- pyproject.toml | 21 +++++++++++++++++ 5 files changed, 68 insertions(+), 51 deletions(-) delete mode 100644 Makefile diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 695290e8..8a1fe45f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,6 +19,6 @@ Here are some key points to include in your description: - [ ] I have written new tests for these changes, as needed. diff --git a/Makefile b/Makefile deleted file mode 100644 index a9833c3e..00000000 --- a/Makefile +++ /dev/null @@ -1,39 +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: ## Format files to match style - poetry run black . - -lint: ## Check style with various tools - poetry check - poetry run pflake8 jrnl tests - poetry run black --check --diff . - -unit: # unit tests - poetry run pytest tests/unit - -bdd: # bdd tests - poetry run pytest tests/bdd --gherkin-terminal-reporter --tb=native - -bdd-debug: # bdd tests - poetry run pytest tests/bdd --gherkin-terminal-reporter --tb=native -x -vv - -test: lint unit bdd - -build: - poetry build - -install: clean ## install the package to the active Python's site-packages - poetry install diff --git a/docs/contributing.md b/docs/contributing.md index ea651df5..650d0cda 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -27,7 +27,7 @@ Please report bugs by [opening a new issue](https://github.com/jrnl-org/jrnl/iss 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 `make html` (or `poetry run mkdocs serve` if on Windows) inside the project's root directory, then navigating your browser to [localhost:8000](http://localhost:8000). +To edit the documentation, edit the `docs/*.md` files on the **develop** branch. You can see the result by running `poe docs` inside the project's root directory, then navigating your browser to [localhost:8000](http://localhost:8000). The `gh-pages` branch is automatically maintained and generated after your changes are merged. You should never have to edit that branch. @@ -85,16 +85,20 @@ In general, pull requests should be made on the `develop` branch. ### Common development commands -You can find an inventory of commands in the `makefile`. \*nix users can run the commands by typing `make` followed by the name of the command; however, Windows users will need to type out the commands directly, or install a third-party make tool such as [GNU Make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm). +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` - * Running tests: `make test` - * Running the source in a virtual environment: + * Installing dependencies: + * `poetry install` + * Activate virtual environment: * `poetry shell` + * Running the source in a virtual environment: * `jrnl` (with or without arguments as necessary) - * Linting the code to standardize its style: `make lint` + * Running tests: + * `poe test` + * Formatting the code to standardize its style: + * `poe format` ### Updating automated tests diff --git a/poetry.lock b/poetry.lock index 88e973cb..1f144a90 100644 --- a/poetry.lock +++ b/poetry.lock @@ -128,7 +128,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" name = "commonmark" version = "0.9.1" description = "Python parser for the CommonMark Markdown spec" -category = "dev" +category = "main" optional = false python-versions = "*" @@ -487,6 +487,14 @@ python-versions = ">=3.6" qa = ["flake8 (==3.8.3)", "mypy (==0.782)"] testing = ["docopt", "pytest (<6.0.0)"] +[[package]] +name = "pastel" +version = "0.2.1" +description = "Bring colors to your terminal." +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + [[package]] name = "pathspec" version = "0.9.0" @@ -538,6 +546,21 @@ python-versions = ">=3.6" dev = ["pre-commit", "tox"] testing = ["pytest", "pytest-benchmark"] +[[package]] +name = "poethepoet" +version = "0.13.1" +description = "A task runner that works well with poetry." +category = "dev" +optional = false +python-versions = ">=3.6.2" + +[package.dependencies] +pastel = ">=0.2.1,<0.3.0" +tomli = ">=1.2.2" + +[package.extras] +poetry_plugin = ["poetry (>=1.0,<2.0)"] + [[package]] name = "pprintpp" version = "0.4.0" @@ -612,7 +635,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" name = "pygments" version = "2.12.0" description = "Pygments is a syntax highlighting package written in Python." -category = "dev" +category = "main" optional = false python-versions = ">=3.6" @@ -747,7 +770,7 @@ pyyaml = "*" name = "rich" version = "12.4.0" description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal" -category = "dev" +category = "main" optional = false python-versions = ">=3.6.3,<4.0.0" @@ -933,7 +956,7 @@ testing = ["pytest", "pytest-bdd", "toml"] [metadata] lock-version = "1.1" python-versions = ">=3.9.0, <3.12" -content-hash = "8cd80d198bf8208d9e4b2054b89a22f1ce9faccc91aaef3440fb22e1782b0239" +content-hash = "7c8a664dc14ce88642bb27318d23b158c044022b791361c98997a3f518c7cd8b" [metadata.files] ansiwrap = [ @@ -1216,6 +1239,10 @@ parso = [ {file = "parso-0.8.3-py2.py3-none-any.whl", hash = "sha256:c001d4636cd3aecdaf33cbb40aebb59b094be2a74c556778ef5576c175e19e75"}, {file = "parso-0.8.3.tar.gz", hash = "sha256:8c07be290bb59f03588915921e29e8a50002acaf2cdc5fa0e0114f91709fafa0"}, ] +pastel = [ + {file = "pastel-0.2.1-py2.py3-none-any.whl", hash = "sha256:4349225fcdf6c2bb34d483e523475de5bb04a5c10ef711263452cb37d7dd4364"}, + {file = "pastel-0.2.1.tar.gz", hash = "sha256:e6581ac04e973cac858828c6202c1e1e81fee1dc7de7683f3e1ffe0bfd8a573d"}, +] pathspec = [ {file = "pathspec-0.9.0-py2.py3-none-any.whl", hash = "sha256:7d15c4ddb0b5c802d161efc417ec1a2558ea2653c2e8ad9c19098201dc1c993a"}, {file = "pathspec-0.9.0.tar.gz", hash = "sha256:e564499435a2673d586f6b2130bb5b95f04a3ba06f81b8f895b651a3c76aabb1"}, @@ -1236,6 +1263,10 @@ pluggy = [ {file = "pluggy-1.0.0-py2.py3-none-any.whl", hash = "sha256:74134bbf457f031a36d68416e1509f34bd5ccc019f0bcc952c7b909d06b37bd3"}, {file = "pluggy-1.0.0.tar.gz", hash = "sha256:4224373bacce55f955a878bf9cfa763c1e360858e330072059e10bad68531159"}, ] +poethepoet = [ + {file = "poethepoet-0.13.1-py3-none-any.whl", hash = "sha256:47e7b38c8b5412f840447f7612a9330697e8633e7500a7340b6734f50e26e380"}, + {file = "poethepoet-0.13.1.tar.gz", hash = "sha256:4f6962f17f5d5a453fd7fa66e3e7897e9191d4289148433efe441c81f2451a46"}, +] pprintpp = [ {file = "pprintpp-0.4.0-py2.py3-none-any.whl", hash = "sha256:b6b4dcdd0c0c0d75e4d7b2f21a9e933e5b2ce62b26e1a54537f9651ae5a5c01d"}, {file = "pprintpp-0.4.0.tar.gz", hash = "sha256:ea826108e2c7f49dc6d66c752973c3fc9749142a798d6b254e1e301cfdbc6403"}, diff --git a/pyproject.toml b/pyproject.toml index e37c3767..b81c285b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -58,6 +58,7 @@ toml = ">=0.10" pytest = ">=6.2" pytest-bdd = ">=4.0.1" ipdb = "*" +poethepoet = "*" pytest-clarity = "*" pyproject-flake8 = "*" yq = "*" @@ -68,6 +69,26 @@ testing = [ "pytest", "pytest-bdd", "toml" ] [tool.poetry.scripts] jrnl = 'jrnl.cli:cli' +[tool.poe.tasks] +bdd = "pytest tests/bdd --gherkin-terminal-reporter --tb=native" +bdd-debug = "poe bdd -x -vv" +format = "black ." +docs = "mkdocs serve" +unit = "pytest tests/unit" + +# Groups of tasks +lint = [ + {cmd = "poetry check"}, + {cmd = "pflake8 jrnl tests"}, + {cmd = "black --check --diff ."}, +] + +test = [ + "lint", + "unit", + "bdd", +] + [tool.isort] multi_line_output = 7 force_single_line = true From 2981de95b00e9ec5dc7c387448a4b3261ed8c4dd Mon Sep 17 00:00:00 2001 From: Jrnl Bot Date: Sat, 18 Jun 2022 18:39:06 +0000 Subject: [PATCH 4/4] Update changelog [ci skip] --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 01522eaa..03730fd2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ **Build:** +- 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)) ## [v3.0-beta](https://pypi.org/project/jrnl/v3.0-beta/) (2022-06-11)