Skip to content

Commit 0a51142

Browse files
authored
updated documentation: py2puml requires python 3.8+ (#18)
1 parent 046dd48 commit 0a51142

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Generate PlantUML class diagrams to document your Python application.
1616
`py2puml` produces a class diagram [PlantUML script](https://plantuml.com/en/class-diagram) representing classes properties (static and instance attributes) and their relations (composition and inheritance relationships).
1717

1818
`py2puml` internally uses code [inspection](https://docs.python.org/3/library/inspect.html) (also called *reflexion* in other programming languages) and [abstract tree parsing](https://docs.python.org/3/library/ast.html) to retrieve relevant information.
19+
Some parsing features are available only since Python 3.8 (like [ast.get_source_segment](https://docs.python.org/3/library/ast.html#ast.get_source_segment)).
1920

2021
## Features
2122

@@ -179,6 +180,7 @@ poetry run python -m pytest -v --cov=py2puml --cov-branch --cov-report term-miss
179180

180181
# Changelog
181182

183+
* `0.5.2`: specify in pyproject.toml that py2puml requires python 3.8+ (`ast.get_source_segment` was introduced in 3.8)
182184
* `0.5.1`: prevent from parsing inherited constructors
183185
* `0.5.0`: handle instance attributes in class constructors, add code coverage of unit tests
184186
* `0.4.0`: add a simple CLI

py2puml/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
def run():
1010
argparser = ArgumentParser(description='Generate PlantUML class diagrams to document your Python application.')
1111

12-
argparser.add_argument('-v', '--version', action='version', version='py2puml 0.5.1')
12+
argparser.add_argument('-v', '--version', action='version', version='py2puml 0.5.2')
1313
argparser.add_argument('path', metavar='path', type=str, help='the path of the domain')
1414
argparser.add_argument('module', metavar='module', type=str, help='the module of the domain', default=None)
1515

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "py2puml"
3-
version = "0.5.1"
3+
version = "0.5.2"
44
description = "Generate PlantUML class diagrams to document your Python application."
55
keywords = ["class diagram", "PlantUML", "documentation", "inspection", "AST"]
66
readme = "README.md"
@@ -13,7 +13,7 @@ license = "MIT"
1313
py2puml = 'py2puml.cli:run'
1414

1515
[tool.poetry.dependencies]
16-
python = "^3.7"
16+
python = "^3.8"
1717

1818
[tool.poetry.dev-dependencies]
1919
pytest = "6.2.2"

tests/py2puml/test__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Ensures the library version is modified in the pyproject.toml file when upgrading it (pull request)
44
def test_version():
5-
assert __version__ == '0.5.1'
5+
assert __version__ == '0.5.2'
66

77
# Description also output in the CLI
88
def test_description():

0 commit comments

Comments
 (0)