Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

normalize pyproject, PEP-621 compliant #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

normalize pyproject, PEP-621 compliant #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
[build-system]
requires = ["setuptools", "flit_core >=2,<4"]
build-backend = "setuptools.build_meta"

[tool.flit.metadata]
module = "sphinxcontrib-kroki"
author = "Martin Hasoň"
author-email = "[email protected]"
home-page = "https://github.com/sphinx-contrib/kroki"
description-file = "README.md"
requires = ["flit_core >=3.5,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "sphinxcontrib.kroki"
readme = "README.md"
requires-python = ">=3.8"
license = {file="LICENSE"}

dynamic = ["version", "description"]

authors = [
{name = "Martin Hasoň", email = "[email protected]"}
]

classifiers = ["License :: OSI Approved :: MIT License"]
requires-python = ">=3.6"
requires = [
dependencies = [
"sphinx",
"requests>=2.4.2",
"pyyaml",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added this because wasn't declared as dep

"requests>=2.4.2"
]

[tool.flit.metadata.requires-extra]
[project.urls]
Homepage = "https://github.com/sphinx-contrib/kroki"

[project.optional-dependencies]
code = ["black", "flake8", "mypy"]
test = [
"coverage",
"pytest",
"pytest-cov",
]
extra = []

[tool.pytest.ini_options]
markers = [
Expand All @@ -31,3 +39,4 @@ markers = [

[tool.black]
line-length = 79
target-version = ["py38"]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't required, black will infer it from the requires-python value

see https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version

38 changes: 0 additions & 38 deletions setup.py
View file
Open in desktop

This file was deleted.

13 changes: 6 additions & 7 deletions sphinxcontrib/kroki/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
"""
sphinxcontrib.kroki
~~~~~~~~~~~~~~~~~~~~~
Embed PlantUML, DOT, etc. diagrams in your documentation using Kroki.
:copyright: Copyright 2020 by Martin Hasoň <[email protected]>
:license: MIT, see LICENSE for details.
Kroki integration into sphinx

Embed PlantUML, DOT, etc. diagrams in your documentation using Kroki.
"""
# copyright: Copyright 2020 by Martin Hasoň <[email protected]>
# license: MIT, see LICENSE for details.

from typing import Any, Dict
from sphinx.application import Sphinx
from .kroki import Kroki
from .transform import KrokiToImageTransform
import pkg_resources

__version__ = pkg_resources.get_distribution("sphinxcontrib-kroki").version
__version__ = "1.3.1"


def setup(app: Sphinx) -> Dict[str, Any]:
Expand Down