jimmy/pyproject.toml at master · marph91/jimmy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "jimmy"
dynamic = ["version"]
description = "Convert your notes to Markdown"
authors = [
    {name = "Marph", email = "[email protected]"},
]
readme = "readme.md"
license = "GPL-3.0-only"
license-files = ["license"]
keywords = ["markdown", "notes", "joplin", "obsidian"]
classifiers = [
    "Environment :: Console",
    "Framework :: MkDocs",
    "Framework :: Pytest",
    "Intended Audience :: End Users/Desktop",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.14",
    "Topic :: Communications :: Email",
    "Topic :: Documentation",
    "Topic :: File Formats",
    "Topic :: Text Processing :: Markup",
    "Topic :: Text Processing :: Markup :: Markdown",
    "Topic :: Text Processing :: Markup :: HTML",
    "Topic :: Text Processing :: Markup :: reStructuredText",
]
requires-python = ">=3.14"
dependencies = [
    "anyblock-exporter @ git+https://github.com/jfcostello/AnyBlock-To-Markdown.git@af1d744",
    "beautifulsoup4==4.15.0",
    "cryptography==50.0.2",
    "markdown==3.11.2",
    "pdf-oxide==0.3.78",
    "platformdirs==4.13.5",
    "puremagic==2.2.0",
    "pycrdt==0.14.10",
    "pypandoc==1.17",
    "pyparsing==3.3.3",
    "python-frontmatter==1.3.0",
    "pyyaml==6.0.3",
    "rich==15.0.0",
    "signal-export==3.9.3",
    "textual==8.2.8",
    "textual-fspicker==1.0.1",
]
[project.scripts]
jimmy = "jimmy.jimmy_cli:main"
[project.urls]
Homepage = "https://github.com/marph91/jimmy"
Documentation = "https://marph91.github.io/jimmy"
Download = "https://github.com/marph91/jimmy/releases"
Repository = "https://github.com/marph91/jimmy"
Issues = "https://github.com/marph91/jimmy/issues"

[tool.hatch.envs.default]
installer = "uv"
[tool.hatch.metadata]
allow-direct-references = true
[tool.hatch.version]
path = "src/jimmy/variables.py"

[dependency-groups]
build = [
    "hatch==1.18.1",
    "pyinstaller==6.22.3",
    "twine==7.0.0",
]
dev = [
    "mypy==2.4.0",
    "parameterized==0.9.0",
    "py7zr==1.1.4",
    "pylint==4.1.3",
    "pytest==9.1.1",
    "pytest-sugar==1.1.1",
    "pytest-xdist==3.8.0",
    "requests==2.34.2",
    "ruff==0.17.1",
    "types-beautifulsoup4==4.12.0.20250516",
    "types-markdown==3.10.2.20261007",
    "types-pyyaml==6.0.12.20260906",
]
docs = [
    "zensical>=0.0.71",
]

[tool.mypy]
# almost like strict, but leave out some too strict checks
warn_unused_configs = true
# disallow_any_generics = true
disallow_subclassing_any = true
# disallow_untyped_calls = true
# disallow_untyped_defs = true
# disallow_incomplete_defs = true
check_untyped_defs = true
# for catch_all_exceptions()
disallow_untyped_decorators = false
warn_redundant_casts = true
warn_unused_ignores = true
# warn_return_any = true
no_implicit_reexport = true
strict_equality = true
extra_checks = true
# for python-markdown
disable_error_code = "attr-defined"
[[tool.mypy.overrides]]
module = [
    "anyblock_exporter",
    "frontmatter",
    "puremagic",
    "pypandoc",
    # "pytodotxt",
    # "stage_left",
    # "stage_left.types"
]
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = ["sigexport.*"]
follow_untyped_imports = true

[tool.pylint]
disable = [
    # f-strings are convenient. Don't care about the performance (yet).
    "logging-fstring-interpolation",
    "missing-function-docstring",
    "missing-class-docstring",
    # needed for flexible base class
    "arguments-differ",
    # too many
    "too-many-branches",
    "too-many-instance-attributes",
    "too-many-locals",
    "too-many-statements",
]
min-similarity-lines = 10
notes = []  # don't show todos

[tool.ruff]
# Set the maximum line length to 88.
line-length = 100
# Include pyinstaller spec files.
extend-include = ["*.spec"]
[tool.ruff.lint]
# all rules: https://docs.astral.sh/ruff/rules/
select = [
    "B",    # flake8-bugbear
    "E",    # pycodestyle errors
    "F",    # Pyflakes
    "I",  # isort
    "N",    # pep8-naming
    # "PL",   # Pylint
    # "RUF",  # ruff
    # "S",  # flake8-bandit
    "SIM",  # flake8-simplify
    "UP",   # pyupgrade
    "W",    # pycodestyle warnings
]
[tool.ruff.lint.isort]
force-sort-within-sections = true  # sort all imports alphabetically
combine-as-imports = true  # sort all imports alphabetically

# use pytest to include unittests and doctests:
# https://stackoverflow.com/questions/43463273/python-m-doctest-ignores-files-with-same-names-in-different-directories
[tool.pytest.ini_options]
addopts = "--log-level DEBUG --verbose --doctest-modules --doctest-continue-on-failure --durations=5 --durations-min=10"
testpaths = ["src/", "test/*.py"]