Skip to content

Commit 4492332

Browse files
fix: use README.md in setup.mustache to generate long description (#4)
1 parent 84f2fab commit 4492332

File tree

6 files changed

+11
-9
lines changed

6 files changed

+11
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Plane REST API
44
Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
55

66
- API version: 0.0.1
7-
- Package version: 0.1.7
7+
- Package version: 0.1.8
88
- Generator version: 7.13.0
99
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1010
For more information, please visit [https://plane.so](https://plane.so)

plane/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
""" # noqa: E501
1616

1717

18-
__version__ = "0.1.7"
18+
__version__ = "0.1.8"
1919

2020
# import apis into sdk package
2121
from plane.api.assets_api import AssetsApi

plane/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def __init__(
8686
self.default_headers[header_name] = header_value
8787
self.cookie = cookie
8888
# Set default User-Agent.
89-
self.user_agent = 'OpenAPI-Generator/0.1.7/python'
89+
self.user_agent = 'OpenAPI-Generator/0.1.8/python'
9090
self.client_side_validation = configuration.client_side_validation
9191

9292
def __enter__(self):

plane/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ def to_debug_report(self) -> str:
548548
"OS: {env}\n"\
549549
"Python Version: {pyversion}\n"\
550550
"Version of the API: 0.0.1\n"\
551-
"SDK Package Version: 0.1.7".\
551+
"SDK Package Version: 0.1.8".\
552552
format(env=sys.platform, pyversion=sys.version)
553553

554554
def get_host_settings(self) -> List[HostSetting]:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "plane"
3-
version = "0.1.7"
3+
version = "0.1.8"
44
description = "The Plane REST API"
55
authors = ["Plane <[email protected]>"]
66
license = "GNU AGPLv3"

setup.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# prerequisite: setuptools
2323
# http://pypi.python.org/pypi/setuptools
2424
NAME = "plane-sdk"
25-
VERSION = "0.1.7"
25+
VERSION = "0.1.8"
2626
PYTHON_REQUIRES = ">= 3.9"
2727
REQUIRES = [
2828
"urllib3 >= 2.1.0, < 3.0.0",
@@ -31,6 +31,10 @@
3131
"typing-extensions >= 4.7.1",
3232
]
3333

34+
# Read README.md for long description
35+
with open("README.md", "r", encoding="utf-8") as fh:
36+
long_description = fh.read()
37+
3438
setup(
3539
name=NAME,
3640
version=VERSION,
@@ -44,8 +48,6 @@
4448
include_package_data=True,
4549
license="GNU AGPLv3",
4650
long_description_content_type='text/markdown',
47-
long_description="""\
48-
The Plane REST API Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
49-
""", # noqa: E501
51+
long_description=long_description,
5052
package_data={"plane": ["py.typed"]},
5153
)

0 commit comments

Comments
 (0)