Merge pull request #5 from jdvala/update/setup

📝 update setup.py to read README for long description.

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://github.com/jdvala/kawadi/workflows/Build%20main/badge.svg)](https://github.com/jdvala/kawadi/actions)
 [![Code Coverage](https://codecov.io/gh/jdvala/kawadi/branch/main/graph/badge.svg)](https://codecov.io/gh/jdvala/kawadi)
-![kawadi](kawadi.png)
+![kawadi](https://raw.githubusercontent.com/jdvala/kawadi/main/kawadi.png)
 
 
 kawadi (કવાડિ in Gujarati) (Axe in English) is a versatile tool that used as a form of weapon and is used to cut, shape and split wood.

setup.py

@@ -1,3 +1,4 @@
+import os.path as path
 from pathlib import Path
 
 from setuptools import find_packages, setup
@@ -6,6 +7,8 @@
 
 requirements_path = here / "requirements" / "prod.txt"
 
+readme_path = path.join(here, "README.md")
+
 
 def read_requirements(path):
     try:
@@ -15,8 +18,15 @@ def read_requirements(path):
         raise RuntimeError(f"{path} is broken")
 
 
+def read_readme(path):
+    with open(path, mode="rt", encoding="utf-8") as fp:
+        return fp.read()
+
+
 setup(
     name="kawadi",
+    long_description=read_readme(readme_path),
+    long_description_content_type="text/markdown",
     python_requires=">=3.7.0",
     setup_requires=["setuptools_scm"],
     install_requires=read_requirements(requirements_path),
@@ -31,6 +41,16 @@ def read_requirements(path):
     package_data={},
     packages=find_packages(where="src"),
     package_dir={"": "src"},
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Topic :: Utilities",
+    ],
     entry_points={"console_scripts": ["kawadi = kawadi.cli:entrypoint"]},
     author="Jay Vala",
     author_email="[email protected]",

src/kawadi/_repo_version.py

@@ -1 +1 @@
-version = "0.1.dev5+dirty"
+version = "0.1.dev8+dirty"