Prepare for initial release on PyPi

README.md

@@ -10,13 +10,18 @@
  * SPDX-License-Identifier: EPL-2.0
 -->
 
-[![REUSE status](https://api.reuse.software/badge/gitlab.eclipse.org/eclipse/technology/dash/ip-check)](https://api.reuse.software/info/gitlab.eclipse.org/eclipse/technology/dash/ip-check)
+Eclipse IP Analysis
+=============
+![PyPI - Version](https://img.shields.io/pypi/v/eclipse-ipa)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eclipse-ipa)
 [![License](https://img.shields.io/badge/License-EPL_2.0-green.svg)](https://www.eclipse.org/legal/epl-2.0/)
+[![REUSE status](https://api.reuse.software/badge/gitlab.eclipse.org/eclipse/technology/dash/ip-check)](https://api.reuse.software/info/gitlab.eclipse.org/eclipse/technology/dash/ip-analysis)
 
 # About
 
-Eclipse IP Analysis (IPA) enables seamless dependency analysis in GitLab and GitHub projects, groups and organizations 
-using the Eclipse Dash tool. As the default output, it generates a comprehensive report file with the results.
+Eclipse IP Analysis (IPA) enables seamless third-party dependency analysis in GitLab and GitHub repositories and
+groups/organizations using the [Eclipse Dash License Tool](https://github.com/eclipse-dash/dash-licenses).
+As default output, it generates a comprehensive HTML report with the results.
 
 _List of currently supported programming languages: Go, Java (Maven and Gradle), JavaScript (NPM and Yarn),
 TypeScript (NPM and Yarn), Kotlin (Gradle), Python._
@@ -25,13 +30,12 @@ TypeScript (NPM and Yarn), Kotlin (Gradle), Python._
 
 ## Base Requirements
 
-In order to run the tool, you must install the base requirements described below.
+To run the tool, you must install the base requirements described below.
 
-- Python >=3.9: check your Python version with the command ```python --version```. In some systems, you may not have
-the alias for Python mapping to Python 3. In such cases, you can run ```python3 --version```. Moreover, check that you
-have the Python Package Manager (pip) installed. Similar to Python, you can run ```pip --version``` or 
-```pip3 --version```. The resulting line should contain your version of Python at its end. If pip is not installed, 
-official documentation can be followed [here](https://pip.pypa.io/en/stable/installation/).
+- Python >=3.9: check your Python version with the command ```python3 --version```. Also, check that you
+have the Python Package Manager (pip) installed. Similar to Python, you can run ```pip3 --version```. The resulting line 
+should contain your version of Python at its end. If pip is not installed, official documentation can be followed 
+[here](https://pip.pypa.io/en/stable/installation/).
 
 - Java JDK 11 or above: the latest version can be safely installed. Check that Java is installed and what's the current
 version by running the command ```java --version```.
@@ -42,7 +46,11 @@ by running the command ```mvn --version```.
 - Git CLI: the latest version can be safely installed. Check that Git is installed and what's the current version by
 running the command ```git --version```.
 
-## Setup
+## Install
+
+```pip3 install eclipse-ipa```
+
+## Build from Source (Optional)
 
 - Clone this repository using your favorite Git software or the command line. For the command line, please execute:
 
@@ -54,10 +62,7 @@ running the command ```git --version```.
 
 ```hatch build```
 
-```pip install dist/eclipse_ipa-0.1.0.tar.gz```
-
-_Please note that you may need to run ```pip``` as ```pip3``` if pip is not mapped to your 
-version of Python 3, as mentioned in the installation of [Base Requirements](#base-requirements)._
+```pip3 install dist/eclipse_ipa-0.1.0.tar.gz```
 
 ([back to top](#About))
 
@@ -65,11 +70,9 @@ version of Python 3, as mentioned in the installation of [Base Requirements](#ba
 
 Run the tool with the following command:
 
-```eclipse-ipa [-h] [-ci] [-gh] [--gh-token GH_TOKEN] [-gl GITLAB] [--gl-token GL_TOKEN] [-b BRANCH] [-c CONFIG]```
-
-```            [-df DEPENDENCIES_FILE] [-e ECLIPSE_PROJECT] [-g GROUP] [-p PROJECT] [-pf PROJECTS_FILE]```
-
-```            [-r REVIEW] [-s] [-v]```
+```eclipse-ipa [-h] [-ci] [-gh] [--gh-token GH_TOKEN] [-gl GITLAB] [--gl-token GL_TOKEN]```
+```            [-b BRANCH] [-c CONFIG] [-df DEPENDENCIES_FILE] [-e ECLIPSE_PROJECT]```
+```            [-g GROUP] [-p PROJECT] [-pf PROJECTS_FILE] [-r REVIEW] [-s] [-v]```
 
 The command does not require any of its options. However, a minimum set is needed to execute simple IP analysis if
 a configuration file is not specified.
@@ -109,8 +112,8 @@ To start using the tool, you must provide **one of the following _six_ options**
 1. An Eclipse Project ID (e.g., technology.dash). This is specified with option -e as summarized above.
 
 2. A file with the dependency locations to analyze. Each line should contain the GitHub/GitLab Project ID, the full
-location path, and the programming language, all separated by semicolons (;). The full path of this file is specified with
-option -df as summarized above.
+location path, and the programming language, all separated by semicolons (;). The full path of this file is specified 
+with option -df as summarized above.
 
 Example for a GitHub line:
 
@@ -131,7 +134,8 @@ Example for a GitLab line:
 
 ```eclipse/technology/dash/ip-analysis```
 
-4. Your specific GitHub Organization, or your specific GitLab Group. This is specified with option -g as summarized above.
+4. Your specific GitHub Organization, or your specific GitLab Group. This is specified with option -g as summarized
+above.
 
 5. Your specific GitHub Project (full name including Organization), or your specific GitLab Project (full name including 
 namespace). This is specified with option -p as summarized above.
@@ -141,7 +145,7 @@ is provided in the same folder as the tool with the filename *config.ini.sample*
 described in the comments.
 
 _Please note that, for GitHub API public access, the API rate limits are very low. It's recommended to provide an access 
-token if running for GitHub projects._
+token if such cases._
 
 ## How the tool works
 

pyproject.toml

@@ -19,20 +19,26 @@ dynamic = ["version"]
 authors = [
   { name="André Gomes", email="andre.gomes@eclipse-foundation.org" },
 ]
-description = "A package to perform IP Analysis for GitHub and GitLab projects"
+description = "Tool to perform IP Analysis for GitHub and GitLab repositories."
 readme = "README.md"
-license = { text = "EPL-2.0" }
 requires-python = ">=3.9"
 dependencies = ["chardet==5.2.0", "Jinja2==3.1.6", "PyGithub==2.6.1", "python-gitlab==6.1.0", "requests==2.32.4"]
 classifiers = [
-    "Programming Language :: Python :: 3",
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
     "License :: OSI Approved :: Eclipse Public License 2.0 (EPL-2.0)",
     "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
 ]
 
 [project.scripts]
 eclipse-ipa = 'ipa:main'
 
+[project.urls]
+"Homepage" = "https://projects.eclipse.org/projects/technology.dash"
+"Source" = "https://gitlab.eclipse.org/eclipse/technology/dash/ip-analysis"
+
 [tool.hatch.build.targets.sdist]
 exclude = [
   "/.git",