mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
4392e29742
* 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>
68 lines
2.4 KiB
Python
68 lines
2.4 KiB
Python
# encoding: utf-8
|
|
# Copyright (C) 2012-2021 jrnl contributors
|
|
# License: https://www.gnu.org/licenses/gpl-3.0.html
|
|
|
|
import json
|
|
|
|
from jrnl.plugins.base import BaseExporter
|
|
from jrnl.plugins.util import get_tags_count
|
|
|
|
from ... import __version__
|
|
|
|
|
|
class Exporter(BaseExporter):
|
|
"""This Exporter can convert entries and journals into json."""
|
|
|
|
names = ["json"]
|
|
extension = "json"
|
|
version = __version__
|
|
|
|
@classmethod
|
|
def entry_to_dict(cls, entry):
|
|
entry_dict = {
|
|
"title": entry.title,
|
|
"body": entry.body,
|
|
"date": entry.date.strftime("%Y-%m-%d"),
|
|
"time": entry.date.strftime("%H:%M"),
|
|
"tags": entry.tags,
|
|
"starred": entry.starred,
|
|
}
|
|
if hasattr(entry, "uuid"):
|
|
entry_dict["uuid"] = entry.uuid
|
|
if (
|
|
hasattr(entry, "creator_device_agent")
|
|
or hasattr(entry, "creator_generation_date")
|
|
or hasattr(entry, "creator_host_name")
|
|
or hasattr(entry, "creator_os_agent")
|
|
or hasattr(entry, "creator_software_agent")
|
|
):
|
|
entry_dict["creator"] = {}
|
|
if hasattr(entry, "creator_device_agent"):
|
|
entry_dict["creator"]["device_agent"] = entry.creator_device_agent
|
|
if hasattr(entry, "creator_generation_date"):
|
|
entry_dict["creator"]["generation_date"] = str(
|
|
entry.creator_generation_date
|
|
)
|
|
if hasattr(entry, "creator_host_name"):
|
|
entry_dict["creator"]["host_name"] = entry.creator_host_name
|
|
if hasattr(entry, "creator_os_agent"):
|
|
entry_dict["creator"]["os_agent"] = entry.creator_os_agent
|
|
if hasattr(entry, "creator_software_agent"):
|
|
entry_dict["creator"]["software_agent"] = entry.creator_software_agent
|
|
|
|
return entry_dict
|
|
|
|
@classmethod
|
|
def export_entry(cls, entry):
|
|
"""Returns a json representation of a single entry."""
|
|
return json.dumps(cls.entry_to_dict(entry), indent=2) + "\n"
|
|
|
|
@classmethod
|
|
def export_journal(cls, journal):
|
|
"""Returns a json representation of an entire journal."""
|
|
tags = get_tags_count(journal)
|
|
result = {
|
|
"tags": {tag: count for count, tag in tags},
|
|
"entries": [cls.entry_to_dict(e) for e in journal.entries],
|
|
}
|
|
return json.dumps(result, indent=2)
|