Merge pull request #23 from meanrin/updates-for-pypi

Updates for pypi

README.md

@@ -1,6 +1,6 @@
 # CredSweeper
 
-<img src="doc/images/Logo.png" width="500"/>
+<img src="https://raw.githubusercontent.com/Samsung/CredSweeper/main/doc/images/Logo.png" width="500"/>
 
 ## Table of Contents
 
@@ -30,27 +30,23 @@ CredSweeper is a tool to detect credentials in any directories or files. CredSwe
 ### Installation
 #### Via pip
 
-Stable (release 1.0.0):
-``` bash
-# With Ml validation feature
-$ pip install git+https://github.com/Samsung/[email protected]
+Without Ml validation feature
+```bash
+pip install credsweeper
 ```
 
-Latest (current master branch):
-``` bash
-# Without Ml validation feature
-$ pip install git+https://github.com/Samsung/CredSweeper.git
-# With Ml validation feature
-$ pip install CredSweeper[ml]@git+https://github.com/Samsung/CredSweeper.git
+With Ml validation feature
+```bash
+pip install credsweeper[ml]
 ```
 
 #### Via git clone (dev install)
 
 ``` bash
-$ git clone https://github.com/Samsung/CredSweeper.git
-$ cd CredSweeper
+git clone https://github.com/Samsung/CredSweeper.git
+cd CredSweeper
 # Annotate "numpy", "scikit-learn", and "tensorflow" if you don't want to use the ML validation feature.
-$ pip install -qr requirements.txt 
+pip install -qr requirements.txt 
 ```
 
 ### Run

setup.py

@@ -19,7 +19,7 @@
 ]
 
 setuptools.setup(
-    name="CredSweeper",
+    name="credsweeper",
     version="1.0.0",
     description="Credential Sweeper",
     long_description=long_description,
@@ -43,4 +43,19 @@
         "ml": ml_requires
     },
     include_package_data=True,
+    url="https://github.com/Samsung/CredSweeper",
+    project_urls={
+        "Bug Tracker": "https://github.com/Samsung/CredSweeper/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Topic :: Security",
+        "Topic :: Software Development :: Quality Assurance"
+    ],
 )