Collect your thoughts and notes without leaving the command line.
Find a file
MinchinWeb 4392e29742 Use implicit namespace plugins for import and export (#1216)
* behavior outline
* FIrst pass at allow external plugins
* remove template exporter
* Add listing of active plugins to '--version' output
* Documentation for plugins
* [Docs] add custom imports and exporters to site TOC
* [Docs] better linewrapping
* enforce positive initial linewrap
  Check column widths
  update gitignore
  throw error when linewrap too small
  simply check for large enough linewrap value
* delete unused error message
* PR feedback
  make exception more informative
  update check_linewrap signature in src and test
  make check_linewrap a free function
* delete unused function
* delete else..pass block
* newline for make format
* Include dates_exporter
* Use Base classes for importer and exporters.
* [Docs] improve documentation of custom Importers and Exporters
* [Testing] separate run with external plugin!
* basic behavior test
* prototype unittest for JSON Exporter
  test for unimplemented method
* make format
  delete unused imports
* Remove 'importer' or 'exporter' from filenames where not needed
* [Test] run different tests with or without the external plugins installed
* [Test] move test rot13 plugin into git tree
  from 0dc912af82
* consolidate demo plugins to common package
* [Docs] name page for plugins
* [Docs] include the sample plug in code files directly
* style fixes
* [test] determine whether to run external plug in tests based on installed packages
* improved code documentation
* style fixes for GitHub actions
* Convert "short" and "pretty" (and "default") formaters to plugins
  further to https://github.com/jrnl-org/jrnl/pull/1177
* more code clean up
  tests pass locally...now for GitHub...
* [tests] dynamically determine jrnl version for plugin tests
* [GitHub Actions] direct install of testing plugins
* Remove template code
* [plugins] meta --> collector
* [Docs] create scripted entries using an custom importer
* (closer to) being able to run behave tests outside project root directory
* We already know when exporter to use
  Don't re-calculate it!
* [Tests] don't name test plugin 'testing"
  If so named, pip won't install it.
* [Test] run behave tests with test plugins outside project root
* [Test] behave tests pass locally
* [Docs] fix typo
* [GitHub Actions] run test commands from poetry's shell
* black-ify code
* [GitHub Actions] move downstream (rather than up) to run tests
* [GitHub Actions] set shell to poetry
* [GitHub Workflows] Manually activate virtual environment
* [GitHub Actions] Skip Windows & Python 3.8
  Can't seem to find Python exe?
* [GiotHub Actions] explicitly use virtual env
* [GitHub Actions] create virutal env directly
* [GitHub Actions] better activate of Windows virtual env
* [GitHub Actions] create virtual env on Mac
* [Github Actions] install wheel and upgrade pip
* [GitHub Actions] skip virtual environments altogether
* [GitHub Actions] change directory for behave test
* Remove Windows exclusions from CI as per note -- they should be working now

Co-authored-by: Suhas <sugas182@gmail.com>
Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
2021-07-17 14:58:15 -07:00
.build Add changelog generation workflow to github actions (#1086) 2020-11-21 11:21:19 -08:00
.github Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
docs Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
docs_theme Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
features Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
jrnl Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
tests Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
.gitattributes Fix annoying poetry-generated Windows line endings 2021-07-03 15:49:18 -07:00
.gitignore Allow runtime configuration overrides from the commandline (#1169) 2021-03-02 18:47:57 -08:00
CHANGELOG.md Update changelog [ci skip] 2021-07-17 20:23:48 +00:00
CODE_OF_CONDUCT.md Update the code of conduct (#913) 2020-04-18 12:35:46 -07:00
CONTRIBUTING.md Emphasize installing dependencies before testing (#1148) 2021-01-09 11:07:03 -08:00
issue_template.md Clean up templates and issues (#954) 2020-05-23 15:58:04 -07:00
LICENSE.md Upgrade license to GPLv3 (#918) 2020-04-18 13:31:25 -07:00
Makefile move some files around because pytest is being weird 2021-07-03 15:49:18 -07:00
mkdocs.yml Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
poetry.lock Use implicit namespace plugins for import and export (#1216) 2021-07-17 14:58:15 -07:00
pyproject.toml Add documentation about saved passwords in Windows (#1301) 2021-07-17 13:22:01 -07:00
README.md Add brew and gitter badges to README 2021-01-30 13:31:24 -08:00
readthedocs.yml Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00
SECURITY.md Add first draft of security.md (#1299) 2021-07-17 12:01:59 -07:00

jrnl Testing Downloads Version Homebrew Gitter

To get help, submit an issue on Github.

jrnl is a simple journal application for the command line.

You can use it to easily create, search, and view journal entries. Journals are stored as human-readable plain text, and can also be encrypted using AES encryption.

In a Nutshell

To make a new entry, just enter

jrnl yesterday: Called in sick. Used the time to clean the house and write my
book.

yesterday: is interpreted by jrnl as a timestamp. Everything until the first sentence ending (either ., ?, or !) is interpreted as the title, and the rest as the body. In your journal file, the result will look like this:

[2012-03-29 09:00] Called in sick.
Used the time to clean the house and write my book.

If you just call jrnl, you will be prompted to compose your entry - but you can also configure jrnl to use your external editor.

For more information, please read the documentation.

Contributors

Maintainers

Our maintainers help keep the lights on for the project:

Please thank them if you like jrnl!

Code Contributors

This project is made with love by the many fabulous people who have contributed. jrnl couldn't exist without each and every one of you!

If you'd also like to help make jrnl better, please see our contributing documentation.

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 and help us sustain our community.