Merge pull request #68 from vc1492a/67-display-readme-properly-on-pypi

67 display readme properly on pypi
vc1492a · Oct 21, 2024 · f78929a · f78929a
2 parents bbdd12a + 85312da
commit f78929a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/LICENSE.txt → LICENSE b/LICENSE.txt → LICENSE
diff --git a/setup.py b/setup.py
@@ -1,5 +1,9 @@
 from setuptools import setup
 
+from pathlib import Path
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(
     name='PyNomaly',
     packages=['PyNomaly'],
@@ -9,6 +13,8 @@
                 'method providing an outlier score in the range of [0,1].',
     author='Valentino Constantinou',
     author_email='[email protected]',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     url='https://github.com/vc1492a/PyNomaly',
     download_url='https://github.com/vc1492a/PyNomaly/archive/0.3.4.tar.gz',
     keywords=['outlier', 'anomaly', 'detection', 'machine', 'learning',