Skip to content

Commit

Permalink
migrate to justfile
Browse files Browse the repository at this point in the history
  • Loading branch information
danielfrg committed Jul 20, 2024
1 parent 81f2ad1 commit 6697007
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 36 deletions.
10 changes: 3 additions & 7 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,14 @@ check:

fmt:
rye run isort .
rye run black .
rye run ruff check --fix mkdocs_jupyter
rye run ruff format

test FILTER="":
rye run pytest -k "{{FILTER}}"

test-all:
rye run pytest .

report:
coverage xml
coverage html
rye run coverage xml
rue run coverage html

publish:
rye publish
Expand Down
38 changes: 26 additions & 12 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
name = "mkdocs-jupyter"
description = "Use Jupyter in mkdocs websites"
readme = "README.md"
requires-python = ">=3.8"
requires-python = ">=3.9"
license = { "text" = "Apache-2.0" }
keywords = ["mkdocs", "jupyter", "jupyterlab", "notebooks", "documentation"]
authors = [{ name = "Daniel Rodriguez", email = "daniel@danielfrg.com" }]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]
Expand Down Expand Up @@ -47,6 +47,10 @@ dev-dependencies = [
[project.entry-points."mkdocs.plugins"]
mkdocs-jupyter = "mkdocs_jupyter.plugin:Plugin"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build]
artifacts = ["src/mkdocs_jupyter/**"]
exclude = [".github", "docs"]
Expand Down Expand Up @@ -84,10 +88,17 @@ parallel = true
omit = ["tests/*"]

[tool.coverage.report]
exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
exclude_lines = [
"no cov",
"if __name__ == .__main__.:",
"if TYPE_CHECKING:",
"pragma: no cover",
"raise NotImplementedError",
]


[tool.ruff]
select = [
lint.select = [
"E", # pycodestyle errors
"W", # pycodestyle warnings
"F", # pyflakes
Expand All @@ -101,14 +112,11 @@ profile = "black"
[tool.mypy]
strict = true

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project.urls]
Documentation = "https://github.com/danielfrg/mkdocs-jupyter#readme"
Issues = "https://github.com/danielfrg/mkdocs-jupyter/issues"
Source = "https://github.com/danielfrg/mkdocs-jupyter"
[tool.pydocstyle]
add_ignore = ["D100", "D101", "D102", "D103", "D104", "D105"]
convention = "numpy"
inherit = false
match_dir = "mkdocs_jupyter"

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
Expand All @@ -117,3 +125,9 @@ check-hidden = true
# image embeddings and all generally too long lines in "", and all urls
ignore-regex = '(^\s*"(image/\S+": "|.{300,}).*|https?://\S+)'
# ignore-words-list = ''

[project.urls]
Documentation = "https://github.com/danielfrg/mkdocs-jupyter#readme"
Issues = "https://github.com/danielfrg/mkdocs-jupyter/issues"
Source = "https://github.com/danielfrg/mkdocs-jupyter"

9 changes: 0 additions & 9 deletions requirements-dev.lock
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,6 @@ importlib-metadata==7.1.0
# via markdown
# via mkdocs
# via nbconvert
importlib-resources==6.4.0
# via jsonschema
# via jsonschema-specifications
# via jupyterlab
iniconfig==2.0.0
# via pytest
ipykernel==6.29.4
Expand Down Expand Up @@ -234,8 +230,6 @@ pickleshare==0.7.5
pip==24.0
# via pip-tools
pip-tools==7.4.1
pkgutil-resolve-name==1.3.10
# via jsonschema
platformdirs==4.2.0
# via black
# via jupyter-core
Expand Down Expand Up @@ -278,8 +272,6 @@ python-dateutil==2.9.0.post0
# via jupyter-client
python-json-logger==2.0.7
# via jupyter-events
pytz==2024.1
# via babel
pyyaml==6.0.1
# via jupyter-events
# via jupytext
Expand Down Expand Up @@ -387,4 +379,3 @@ wheel==0.43.0
# via pip-tools
zipp==3.18.1
# via importlib-metadata
# via importlib-resources
8 changes: 0 additions & 8 deletions requirements.lock
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,6 @@ importlib-metadata==7.1.0
# via markdown
# via mkdocs
# via nbconvert
importlib-resources==6.4.0
# via jsonschema
# via jsonschema-specifications
ipykernel==6.29.4
# via mkdocs-jupyter
ipython==8.12.3
Expand Down Expand Up @@ -139,8 +136,6 @@ pexpect==4.9.0
# via ipython
pickleshare==0.7.5
# via ipython
pkgutil-resolve-name==1.3.10
# via jsonschema
platformdirs==4.2.0
# via jupyter-core
# via mkdocs
Expand All @@ -162,8 +157,6 @@ pymdown-extensions==10.7.1
python-dateutil==2.9.0.post0
# via ghp-import
# via jupyter-client
pytz==2024.1
# via babel
pyyaml==6.0.1
# via jupytext
# via mkdocs
Expand Down Expand Up @@ -222,4 +215,3 @@ webencodings==0.5.1
# via tinycss2
zipp==3.18.1
# via importlib-metadata
# via importlib-resources

0 comments on commit 6697007

Please sign in to comment.