Skip to content

Commit

Permalink
chore: improve setup.py dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
JakubAndrysek committed Jun 18, 2024
1 parent b06e3be commit 1702d0f
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 36 deletions.
2 changes: 1 addition & 1 deletion .idea/main-mkdoxy.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

55 changes: 33 additions & 22 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@ docs-serve:

docs-build: # results in site directory
mkdocs build

pre-commit:
pre-commit run --show-diff-on-failure --color=always --all-files
7 changes: 7 additions & 0 deletions devdeps.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
mkdocs-material~=9.5.18
mkdocs-open-in-new-tab~=1.0.2
pathlib~=1.0.1
isort~=5.13.2
pytest~=8.2.2
pre-commit~=3.7.0
setuptools~=70.0.0
31 changes: 19 additions & 12 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,28 @@ def requirements():
return f.read().splitlines()


def import_requirements():
"""Imports requirements from requirements.txt file."""
with open("requirements.txt") as f:
return f.read().splitlines()


def import_dev_requirements():
"""Imports requirements from devdeps.txt file."""
with open("devdeps.txt") as f:
return f.read().splitlines()


# https://pypi.org/project/mkdoxy/
setup(
name="mkdoxy",
version="1.2.4",
version="1.2.5",
description="MkDoxy → MkDocs + Doxygen = easy documentation generator with code snippets",
long_description=readme(),
long_description_content_type="text/markdown",
keywords="mkdoxy, python, open-source, documentation, mkdocs, doxygen, multilanguage, code-snippets, code, snippets, documentation-generator", # noqa: E501
keywords="mkdoxy, python, open-source, documentation, mkdocs, doxygen, "
"multilanguage, code-snippets, code, snippets, documentation-generator",
# noqa: E501
url="https://github.com/JakubAndrysek/MkDoxy",
author="Jakub Andrýsek",
author_email="[email protected]",
Expand All @@ -30,23 +44,16 @@ def requirements():
"Tracker": "https://github.com/JakubAndrysek/MkDoxy/issues",
"Funding": "https://github.com/sponsors/jakubandrysek",
},
install_requires=["mkdocs"],
install_requires=import_requirements(),
extras_require={
"dev": [
"mkdocs-material~=9.5.18",
"Jinja2~=3.1.3",
"mkdocs-open-in-new-tab~=1.0.2",
"pathlib~=1.0.1",
"isort~=5.12.0",
"pytest~=6.2.5",
"pre-commit~=3.7.0",
],
"dev": import_dev_requirements(),
},
classifiers=[
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Operating System :: OS Independent",
],
packages=find_packages(),
Expand Down

0 comments on commit 1702d0f

Please sign in to comment.