Skip to content

Commit 9587f59

Browse files
authored
Use OpenAPI doc version as generated client version (#135)
* The version of the OpenAPI doc is now used as the generated library's version Co-authored-by: Ethan Mann <[email protected]>
1 parent a2206b0 commit 9587f59

File tree

4 files changed

+12
-3
lines changed

4 files changed

+12
-3
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77

8+
## 0.5.2 - unreleased
9+
### Fixes
10+
- The generated library's version is now the same as the OpenAPI doc's version (#134)
11+
812
## 0.5.1 - 2020-08-05
913
### Fixes
1014
- Relative paths are now allowed in securitySchemes/OAuthFlow/tokenUrl (#130).

openapi_python_client/__init__.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ def __init__(self, *, openapi: GeneratorData) -> None:
105105

106106
self.package_name: str = self.project_name.replace("-", "_")
107107
self.package_dir: Path = self.project_dir / self.package_name
108-
self.package_description = f"A client library for accessing {self.openapi.title}"
108+
self.package_description: str = f"A client library for accessing {self.openapi.title}"
109+
self.version: str = openapi.version
109110

110111
self.env.filters.update(self.TEMPLATE_FILTERS)
111112

@@ -167,7 +168,10 @@ def _build_metadata(self) -> None:
167168
pyproject_path = self.project_dir / "pyproject.toml"
168169
pyproject_path.write_text(
169170
pyproject_template.render(
170-
project_name=self.project_name, package_name=self.package_name, description=self.package_description
171+
project_name=self.project_name,
172+
package_name=self.package_name,
173+
version=self.version,
174+
description=self.package_description,
171175
)
172176
)
173177

openapi_python_client/templates/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "{{ project_name }}"
3-
version = "0.1.0"
3+
version = "{{ version }}"
44
description = "{{ description }}"
55

66
authors = []

tests/test___init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,7 @@ def test__build_metadata(self, mocker):
361361
pyproject_template.render.assert_called_once_with(
362362
project_name=project.project_name,
363363
package_name=project.package_name,
364+
version=project.version,
364365
description=project.package_description,
365366
)
366367
pyproject_path.write_text.assert_called_once_with(pyproject_template.render())

0 commit comments

Comments
 (0)