Skip to content

Commit 235b6c9

Browse files
committed
Use README for PyPI documentation
1 parent 52592d8 commit 235b6c9

1 file changed

Lines changed: 5 additions & 13 deletions

File tree

setup.py

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# coding: utf-8
2-
32
"""
43
Dyspatch API
54
@@ -15,8 +14,6 @@
1514
Contact: support@dyspatch.io
1615
Generated by: https://github.com/swagger-api/swagger-codegen.git
1716
"""
18-
19-
2017
from setuptools import setup, find_packages # noqa: H301
2118

2219
NAME = "dyspatch-python"
@@ -30,24 +27,19 @@
3027

3128
REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil"]
3229

30+
with open("README.md") as fp:
31+
long_description = fp.read()
32+
3333
setup(
3434
name=NAME,
3535
version=VERSION,
3636
description="Dyspatch API Client",
37+
author="Dyspatch",
3738
author_email="support@dyspatch.io",
3839
url="https://github.com/getdyspatch/dyspatch-python",
3940
keywords=["Swagger", "Dyspatch API", "OpenAPI"],
4041
install_requires=REQUIRES,
4142
packages=find_packages(),
4243
include_package_data=True,
43-
long_description="""\
44-
# Introduction
45-
46-
The Dyspatch API is based on the REST paradigm, and features resource
47-
based URLs with standard HTTP response codes to indicate errors.
48-
We use standard HTTP authentication and request verbs, and all responses
49-
are JSON formatted. See our
50-
[Implementation Guide](https://docs.dyspatch.io/development/implementing_dyspatch/)
51-
for more details on how to implement Dyspatch.
52-
""",
44+
long_description=long_description,
5345
)

0 commit comments

Comments
 (0)