diff --git a/.build/generate_changelog.sh b/.build/generate_changelog.sh index ea586f4cd..2e1d3f5c8 100755 --- a/.build/generate_changelog.sh +++ b/.build/generate_changelog.sh @@ -59,6 +59,6 @@ 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 commit -m "Update changelog [ci skip]" git push https://${GITHUB_TOKEN}@github.com/jrnl-org/jrnl.git $BRANCH diff --git a/.build/gitlab-ci.yml b/.build/gitlab-ci.yml new file mode 100644 index 000000000..b4d4f4912 --- /dev/null +++ b/.build/gitlab-ci.yml @@ -0,0 +1,36 @@ +# This file is a template, and might need editing before it works on your project. +# Official language image. Look for the different tagged releases at: +# https://hub.docker.com/r/library/python/tags/ +image: python:latest + +# Change pip's cache directory to be inside the project directory since we can +# only cache local items. +variables: + PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" + +# Pip's cache doesn't store the python packages +# https://pip.pypa.io/en/stable/reference/pip_install/#caching +# +# If you want to also cache the installed packages, you have to install +# them in a virtualenv and cache it as well. +cache: + paths: + - .cache/pip + +before_script: + - python -V # Print out python version for debugging + - pip install poetry + +release: + rules: + - if: $RELEASE != null + script: + - git config --global user.email "jrnl.bot@gmail.com" + - git config --global user.name "Jrnl Bot" + - git checkout "$CI_COMMIT_BRANCH" + - poetry version "$RELEASE" + - echo __version__ = \"$RELEASE\" > jrnl/__version__.py + - git add pyproject.toml jrnl/__version__.py + - git commit -m "Increment version to ${RELEASE}" + - git tag -a -m "$RELEASE" "$RELEASE" + - git push --follow-tags "https://${GITHUB_TOKEN}@github.com/jrnl-org/jrnl.git" "$CI_COMMIT_BRANCH" diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..d47e847c4 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +*.journal text eol=lf +*.feature text eol=lf diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 02c0c251e..d93d1422e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,20 +7,36 @@ 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) +## Bug Report + + + +### Environment + - Jrnl version: + - Install method: + - OS + +### Current Behavior + + +### Expected Behavior + + +### Repro Steps + + +### Other Information + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 8690ad715..d90616047 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,12 +8,24 @@ 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! +### Use Case/Motivation + -* **What is the motivation / use case for changing the behavior?** +### Example Usage + -* **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) +### Other information + diff --git a/.github/ISSUE_TEMPLATE/support_request.md b/.github/ISSUE_TEMPLATE/support_request.md index d9608885a..04c2a2170 100644 --- a/.github/ISSUE_TEMPLATE/support_request.md +++ b/.github/ISSUE_TEMPLATE/support_request.md @@ -7,20 +7,33 @@ 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) +## Support Request + + +### Environment + + - Jrnl version: + - Install method: + - OS + +### What are you trying to do? + + +### What have you tried? + + +### Other Information + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 986f10ee5..1d3f0f07c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,26 @@ + -*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/CONTRIBUTING.md). +- [ ] I have included a link to the relevant issue number. +- [ ] I have tested this code locally. +- [ ] 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. +- [ ] All tests pass. + diff --git a/.github/lock.yml b/.github/lock.yml new file mode 100644 index 000000000..8a093a629 --- /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/.gitignore b/.gitignore index 2382cabeb..afb0d8743 100644 --- a/.gitignore +++ b/.gitignore @@ -42,11 +42,13 @@ obj # virtaulenv env/ env*/ +venv*/ +.venv*/ # PyCharm Project files .idea/ -# export testing director +# export testing directories exp/ _extras/ diff --git a/.travis.yml b/.travis.yml index 8c4ff73df..5590cceff 100644 --- a/.travis.yml +++ b/.travis.yml @@ -62,11 +62,15 @@ jobs: - python: nightly include: - - name: Lint, via Black + - name: Misc Linting python: 3.8 script: + - poetry --version + - poetry check - black --version - - black --check . --verbose --diff + - black --check --diff . + - pyflakes --version + - pyflakes . # Python 3.6 Tests - name: Python 3.6 on Linux @@ -90,13 +94,13 @@ jobs: name: Python 3.7 on MacOS python: 3.7 env: - JRNL_PYTHON_VERSION: 3.7.5 + JRNL_PYTHON_VERSION: 3.7.7 - <<: *test_windows name: Python 3.7 on Windows python: 3.7 env: <<: *env_windows - JRNL_PYTHON_VERSION: 3.7.5 + JRNL_PYTHON_VERSION: 3.7.7 # Python 3.8 Tests - name: Python 3.8 on Linux @@ -105,13 +109,13 @@ jobs: name: Python 3.8 on MacOS python: 3.8 env: - JRNL_PYTHON_VERSION: 3.8.0 + JRNL_PYTHON_VERSION: 3.8.2 - <<: *test_windows name: Python 3.8 on Windows python: 3.8 env: <<: *env_windows - JRNL_PYTHON_VERSION: 3.8.0 + JRNL_PYTHON_VERSION: 3.8.2 # ... and beyond! - name: Python nightly on Linux @@ -125,19 +129,9 @@ jobs: 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 script: - echo "Deployment starting..." @@ -146,12 +140,13 @@ jobs: 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 jrnl/__version__.py - - git commit -m "Incrementing version to ${TRAVIS_TAG} [ci skip]" - - git push https://${GITHUB_TOKEN}@github.com/jrnl-org/jrnl.git master + all_branches: true + + # Changelog for Unreleased changes + - stage: Update Changelog + if: (tag IS present) OR (branch = develop AND type NOT IN (pull_request)) + install: + - echo 'Skipping installation step' + script: + - ./.build/generate_changelog.sh + diff --git a/CHANGELOG.md b/CHANGELOG.md index f1eadbd1d..96fe61d85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,41 +2,92 @@ ## [Unreleased](https://github.com/jrnl-org/jrnl/) -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.3.1...HEAD) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.2...HEAD) **Implemented enhancements:** -- Merge in temp branches for v2.4 [\#897](https://github.com/jrnl-org/jrnl/pull/897) ([wren](https://github.com/wren)) +- Speed up jrnl by 10%, improve slow imports [\#959](https://github.com/jrnl-org/jrnl/pull/959) ([wotgl](https://github.com/wotgl)) +- Add extended metadata support for DayOne Classic [\#928](https://github.com/jrnl-org/jrnl/pull/928) ([MinchinWeb](https://github.com/MinchinWeb)) **Fixed bugs:** -- Fix Python 3.9 incompatibility by updating plistlib [\#909](https://github.com/jrnl-org/jrnl/pull/909) ([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 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:** -- Update Poetry requirements for testing latest Python version [\#898](https://github.com/jrnl-org/jrnl/pull/898) ([wren](https://github.com/wren)) +- 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:** -- 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)) +- Extensive modifications to overview.md [\#957](https://github.com/jrnl-org/jrnl/pull/957) ([guydebros](https://github.com/guydebros)) +- Cleaned up usage.md for clarity, formatting, and grammar. [\#956](https://github.com/jrnl-org/jrnl/pull/956) ([guydebros](https://github.com/guydebros)) -## [v2.3.1](https://pypi.org/project/jrnl/v2.3.1/) (2020-03-28) +## [v2.4.2](https://pypi.org/project/jrnl/v2.4.2/) (2020-05-09) -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.3...v2.3.1) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v2.4.1...v2.4.2) **Fixed bugs:** -- Syntax fix [\#886](https://github.com/jrnl-org/jrnl/pull/886) ([minchinweb](https://github.com/minchinweb)) + +- Prevent filtered delete from deleting journal [\#935](https://github.com/jrnl-org/jrnl/pull/935) ([micahellison](https://github.com/micahellison)) **Build:** -- Hotfix to keep the version from releases in sync in repo [\#895](https://github.com/jrnl-org/jrnl/pull/895) ([wren](https://github.com/wren)) -- Update travis caching to speed up builds [\#871](https://github.com/jrnl-org/jrnl/pull/871) ([wren](https://github.com/wren)) + +- 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:** -- Update and reorganize CONTRIBUTING [\#885](https://github.com/jrnl-org/jrnl/pull/885) ([micahellison](https://github.com/micahellison)) -- Update url for "beautiful timeline" in export.md [\#879](https://github.com/jrnl-org/jrnl/pull/879) ([NGenetzky](https://github.com/NGenetzky)) + +- 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) diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 4419cd434..000000000 --- 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 000000000..2fb2e74d8 --- /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 index 798035080..8533dec87 100644 --- a/Makefile +++ b/Makefile @@ -13,13 +13,15 @@ clean: html: poetry run mkdocs serve -format: ## check style with flake8 - poetry run black features jrnl +format: ## Format files to match style + poetry run black . -lint: ## check style with flake8 - poetry run flake8 jrnl features --ignore E501 +lint: ## Check style with various tools + poetry check + poetry run pyflakes . + poetry run black --check --diff . -test: ## Run behave tests +test: lint ## Run behave tests poetry run behave build: diff --git a/README.md b/README.md index 0f444ab2d..ab3e72437 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,74 @@ 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/) ==== -_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) 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 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. -Optionally, your journal can be encrypted using the [256-bit AES](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). ### Why keep a journal? -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. +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, or 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. In a Nutshell ------------- -to make a new entry, just type +To make a new entry, just type - jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book. + jrnl yesterday: Called in sick. Used the time cleaning the house and writing 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: +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: - 2012-03-29 09:00 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 cleaning the house and 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. +If you just call `jrnl`, you will be prompted to compose your entry - but you +can also configure _jrnl_ to use your external editor. -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). +For more information, please read our [documentation](https://jrnl.sh/overview/). -Authors -------- -Current maintainers: +## Contributors +### Maintainers +Our maintainers help keep the lights on for the project. Please thank them if +you like jrnl. * Jonathan Wren ([wren](https://github.com/wren)) * Micah Ellison ([micahellison](https://github.com/micahellison)) -Original maintainer: +### 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! - * Manuel Ebert ([maebert](https://github.com/maebert)) + + +If you'd also like to help make jrnl better, please see our [contributing +documentation](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/docs/advanced.md b/docs/advanced.md index 84bf022df..64b5baa74 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -14,8 +14,8 @@ 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! + Backup your journal and config file before editing. Changes to the config file + can have destructive effects on your journal! - `journals` paths to your journal files diff --git a/docs/encryption.md b/docs/encryption.md index 9909af673..806064b3e 100644 --- a/docs/encryption.md +++ b/docs/encryption.md @@ -31,40 +31,20 @@ your journal. 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 +not on another – you can run `jrnl --encrypt` on an encrypted journal and use the same password again. ## A note on security -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`: +While `jrnl` follows best practices, total security is an illusion. +There are a number of ways that people can at least partially +compromise your `jrnl` data. See the [Privacy and Security](./security.md) +documentation for more information. -``` sh -HISTIGNORE="$HISTIGNORE:jrnl *" -``` - -If you are using zsh instead of bash, you can get the same behaviour by -adding this to your `zshrc`: - -``` sh -setopt HIST_IGNORE_SPACE -alias jrnl=" jrnl" -``` - -If you are using `fish` instead of `bash` or `zsh`, you can get the same behaviour by -adding this to your `fish` configuration: - -``` sh -abbr --add jrnl " jrnl" -``` +## No password recovery -To delete existing `jrnl` commands from `fish`’s history, run -`history delete --prefix 'jrnl '`. +There is no method to recover or reset your `jrnl` password. If you lose it, +your data is inaccessible. ## Manual decryption diff --git a/docs/overview.md b/docs/overview.md index 862118148..6f977ce7f 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,27 +1,62 @@ # 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. +`jrnl`'s goal is to facilitate the rapid creation and viewing of journal +entries. It is flexible enough to support different use cases and organization +strategies. It is powerful enough to search through thousands of entries and +display, or "filter," only the entries you want to see. -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. `jrnl` files can be stored 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 `@`). Entries can be found and filtered + +## Support for Multiple Journals + +`jrnl` includes support for the creation and management 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 of your choice. + +## Encryption + +`jrnl` includes support for [128-bit AES +encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) using +[cryptography.Fernet](https://cryptography.io/en/latest/fernet/). The +[encryption page](./encryption.md) explains `jrnl`'s cryptographic framework in +more detail. + +## Import and Export + +`jrnl` makes it easy to import entries from other sources. Existing entries can +be [exported](./export.md) in a variety of formats. + +## Multi-Platform Support + +`jrnl` is compatible with most operating systems. Pre-compiled binaries are +available through several distribution channels, and you can build from source. +See the [installation page](./installation.md) for more information. + +## 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/recipes.md b/docs/recipes.md index a702b9d6e..923995913 100644 --- a/docs/recipes.md +++ b/docs/recipes.md @@ -73,7 +73,7 @@ jrnlimport () { !!! note Templates require an [external editor](./advanced.md) be configured. -A template is a code snippet that makes it easier to enter use repeated text +A template is a code snippet that makes it easier to use repeated text each time a new journal entry is started. There are two ways you can utilize templates in your entries. diff --git a/docs/security.md b/docs/security.md new file mode 100644 index 000000000..e8525b78a --- /dev/null +++ b/docs/security.md @@ -0,0 +1,74 @@ +# Privacy and Security + +`jrnl` is designed with privacy and security in mind, but there are some +limitations to be aware of. + +## Password strength + +`jrnl` doesn't enforce password strength requirements. Short or commonly-used +passwords can easily be circumvented by someone with basic security skills +and access to your encrypted `jrnl` file. + +## 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 in your `.bashrc`: + +``` sh +HISTIGNORE="$HISTIGNORE:jrnl *" +``` + +### zsh + +Disable history logging by adding this to your `zshrc`: + +``` sh +setopt HIST_IGNORE_SPACE +alias jrnl=" jrnl" +``` + +### fish + +Add this abbreviation to your `fish` configuration to run jrnl with +a space before it, which prevents `fish` from logging it: + +``` sh +abbr --add jrnl " jrnl" +``` + +To delete existing `jrnl` commands from `fish`’s 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 its +history after journaling. + +## Files in transit from editor to jrnl + +When creating or editing an entry, `jrnl` uses a plain text temporary file on disk +to give your editor access to it. `jrnl` deletes the temporary file when it +saves the entry back to your journal. + +If you save an entry but haven't closed your editor yet, and your computer shuts +off or the `jrnl` process is killed, the entry remains on your disk as a +temporary file. You can mitigate this issue by only saving with your editor +right before closing it. + +## 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. + +## Notice any other risks? + +Please let the maintainers know by [filing an issue on GitHub](https://github.com/jrnl-org/jrnl/issues). \ No newline at end of file diff --git a/docs/theme/index.html b/docs/theme/index.html index 89aa3641a..00391e140 100755 --- a/docs/theme/index.html +++ b/docs/theme/index.html @@ -95,7 +95,7 @@

For work and play.