Browse Source

setup.py: use readme as long description

Fabian Peter Hammerle 4 years ago
parent
commit
47400a4add
2 changed files with 6 additions and 0 deletions
  1. 2 0
      CHANGELOG.md
  2. 4 0
      setup.py

+ 2 - 0
CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- package: use readme as long description for pypi.org
 
 ## [1.0.0] - 2019-12-23
 ### Added

+ 4 - 0
setup.py

@@ -1,3 +1,5 @@
+import pathlib
+
 import setuptools
 
 setuptools.setup(
@@ -5,6 +7,8 @@ setuptools.setup(
     use_scm_version=True,
     packages=setuptools.find_packages(),
     description="automates toontown rewritten's login process",
+    long_description=pathlib.Path(__file__).parent.joinpath("README.md").read_text(),
+    long_description_content_type="text/markdown",
     author="Fabian Peter Hammerle",
     author_email="fabian.hammerle@gmail.com",
     url="https://github.com/fphammerle/tooncher",