Add py.typed file to mark package as type-annotated, merge into pyproject.toml (#58)

* Add `py.typed` file to mark package as type-annotated, merge into `pyproject.toml` (#57)

* Fix `borders` type hint

* Clean up `.gitignore`

* Merge dependencies and setup.cfg into Pyproject.toml

* Repair Makefile and GHAs (`requirements -> pyproject.toml`)

* Fix bad Python3.8 type hint

* Fix package build.

* update history.txt

* restore build/.gitignore file

* cosmetic

---------

Co-authored-by: Parker L <166864283+parker-research@users.noreply.github.com>

Author: vb64

.github/workflows/pep257.yml

@@ -1,6 +1,7 @@
 name: pep257
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main

.github/workflows/py3.yml

@@ -2,6 +2,7 @@
 name: py3
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
@@ -28,8 +29,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r tests/requirements.txt
+        pip install '.[dev]'
 
     - name: flake8
       run: |
@@ -67,8 +67,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements_38.txt
-        pip install -r tests/requirements.txt
+        pip install '.[dev]'
 
     - name: flake8
       run: |

.gitignore

@@ -7,3 +7,5 @@ htmlcov/*
 venv*
 dist/
 *.egg-info/
+build/
+.pytest_cache/

history.txt

@@ -1,3 +1,7 @@
++ Added file py.typed.
+
+* Package completely managed by pyproject.toml.
+
 03.04.2025 ver.1.6
 ------------------
 

makefile

@@ -44,7 +44,7 @@ example:
 	$(PYTHON) makepdf.py README_ru.md examples/markdown_pdf_ru.pdf
 
 package:
-	$(PYTHON) -m build -n
+	$(PYTHON) -m build
 
 pypitest: package
 	$(PYTHON) -m twine upload --config-file .pypirc --repository testpypi dist/*
@@ -54,18 +54,9 @@ pypi: package
 
 setup: setup_python setup_pip
 
-setup38: setup_python setup_pip38
-
-setup_pip38:
-	$(PIP) --upgrade pip
-	$(PIP) -r $(TESTS)/requirements.txt
-	$(PIP) -r requirements_38.txt
-	$(PIP) -r deploy.txt
-
 setup_pip:
 	$(PIP) --upgrade pip
-	$(PIP) -r $(TESTS)/requirements.txt
-	$(PIP) -r requirements.txt
+	$(PIP) '.[dev]'
 	$(PIP) -r deploy.txt
 
 setup_python:

markdown_pdf/__init__.py

@@ -2,6 +2,8 @@
 import io
 import typing
 import pathlib
+
+
 from markdown_it import MarkdownIt
 import fitz
 
@@ -15,7 +17,7 @@ def __init__(
       toc: bool = True,
       root: str = ".",
       paper_size: str = "A4",
-      borders: tuple = (36, 36, -36, -36)
+      borders: typing.Tuple[int, int, int, int] = (36, 36, -36, -36)
     ):
         """Create md section with given properties."""
         self.text = text

markdown_pdf/py.typed

@@ -4,3 +4,44 @@ requires = [
     "wheel"
 ]
 build-backend = "setuptools.build_meta"
+
+[project]
+name = "markdown_pdf"
+version = "1.6"
+description = "Markdown to pdf renderer"
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.8"
+license = { text = "GNU Affero General Public License v3" }
+authors = [
+    { name = "Vitaly Bogomolov", email = "mail@vitaly-bogomolov.ru" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent"
+]
+dependencies = [
+    "PyMuPDF==1.24.6; python_version<'3.9'",
+    "PyMuPDF==1.25.3; python_version>'3.8'",
+    "markdown-it-py==3.0.0; python_version>='3.8'"
+]
+
+[project.optional-dependencies]
+dev = [
+    "flake8",
+    "pylint",
+    "pydocstyle",
+    "pytest",
+    "pytest-cov",
+    "codacy-coverage",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/vb64/markdown-pdf"
+"Bug Tracker" = "https://github.com/vb64/markdown-pdf/issues"
+
+[tool.setuptools]
+packages = ["markdown_pdf"]
+
+[tool.setuptools.package-data]
+"markdown_pdf" = ["py.typed"]