Merge pull request #13 from MikhailKravets/release

Release
MikhailKravets · Nov 13, 2022 · 4408b86 · 4408b86
2 parents e60bc0c + accd841
commit 4408b86
Show file tree

Hide file tree

Showing 8 changed files with 149 additions and 168 deletions.
diff --git a/.docs/logo.png b/.docs/logo.png
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -12,7 +12,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    outputs:
+      coverage: ${{ steps.test.outputs.coverage }}
 
     steps:
       - uses: actions/checkout@v3
@@ -41,6 +43,7 @@ jobs:
       - name: Lint with flake8
         run: flake8 .
         continue-on-error: true
-      - name: Test with pytest
-        run: |
-          pytest
+
+      - id: test
+        name: Test with pytest
+        run: pytest --cov-report term --cov=mkdocs_puml -q tests/
diff --git a/Pipfile b/Pipfile
@@ -11,10 +11,12 @@ mkdocs = "~=1.3"
 [dev-packages]
 mkdocs-material = "*"
 mkdocs-awesome-pages-plugin = "*"
-pytest = "*"
+pytest = "~=7.2.0"
 pytest-cov = "*"
 flake8 = "*"
 pre-commit = "*"
+importlib-metadata = {version = "*", markers = "python_version < '3.10'"}
+zipp = {version = "*", markers = "python_version < '3.10'"}
 
 [requires]
 python_version = "3.10"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# mkdocs-puml
+![logo](.docs/logo.png)
 
 [![PyPI version](https://badge.fury.io/py/mkdocs_puml.svg)](https://badge.fury.io/py/mkdocs_puml)
 
-`mkdocs_puml` is a fast and simple package that brings PUML diagrams into `mkdocs`
+`mkdocs_puml` is a fast and simple package that brings plantuml diagrams into mkdocs
 documentation.
 
 ## Install
@@ -128,3 +128,5 @@ substitutes uuid codes in markdown files with the `svg` images.
 ## License
 
 The project is licensed under [MIT license](LICENSE).
+
+Diagram icon created by [Freepik](https://www.flaticon.com/free-icon/flow-chart_4411911?related_id=4411911&origin=search).
diff --git a/mkdocs_puml/__init__.py b/mkdocs_puml/__init__.py
@@ -1,3 +1,3 @@
 """Package that brings PlantUML into MkDocs"""
 
-__version__ = "0.3"
+__version__ = "1.0"
diff --git a/mkdocs_puml/puml.py b/mkdocs_puml/puml.py
@@ -17,14 +17,12 @@ class PlantUML:
     Attributes:
         base_url (str): Base URL to the PUML service
         num_worker (int): The size of pool to run requests in
-        _format (str): The format of build diagram. Used in the requesting URL
-        _html_comment_regex (re.Pattern): Regex pattern to remove html comments from received svg
 
     Examples:
         Use this class as::
 
             puml = PlantUML("https://www.plantuml.com")
-            svg = puml.translate(diagram)
+            svg = puml.translate([diagram])[0]
     """
     _format = 'svg'
     _html_comment_regex = re.compile(r"<!--.*?-->", flags=re.DOTALL)

diff --git a/pyproject.toml b/pyproject.toml
@@ -9,7 +9,7 @@ readme = "README.md"
 license = {file = "LICENSE"}
 classifiers = ["License :: OSI Approved :: MIT License"]
 dynamic = ["version", "description"]
-requires-python = ">=3.6"
+requires-python = ">=3.7"
 dependencies = [
     "requests >= 2.27, < 3.0",
     "markdown >= 3.4, < 4.0",