PYSCAN-35: Decide for a package name and a CLI command name (#39)

Author: joke1196

README.md

@@ -1,38 +1,38 @@
-# sonar-scanner-python
+# pysonar
 A wrapper around SonarScanner CLI, available on PyPI.
 
 # Installation
 
 Install with pip:
 ```
-pip install sonar-scanner-python FIXME -- The actual package name is not yet defined. Refer to PYSCAN-35
+pip install pysonar
 ```
 
 # Usage
 
-Once installed, the `sonar-scanner-python` can be run from the command line to perform an analysis.
+Once installed, the `pysonar` can be run from the command line to perform an analysis.
 It assumes a running SonarQube server or a project configured on SonarCloud.
 
 ## Setting up analysis properties
 
 In order for the analysis to run, analysis properties need to be defined. 
 There are multiple ways of providing these properties, described below in descending order of priority:
 
-* Through CLI arguments to the `sonar-scanner-python` command
+* Through CLI arguments to the `pysonar` command
 * Under the `[tool.sonar]` key of the `pyproject.toml` file
 * Through common properties extracted from the `pyproject.toml`
 * In a dedicated `sonar-project.properties` file
 * Through environment variables
 
 ### Through CLI arguments
 
-Analysis properties can be provided as CLI arguments to the `sonar-scanner-python` command.
+Analysis properties can be provided as CLI arguments to the `pysonar` command.
 They follow the same convention as when running the SonarScanner CLI directly 
 (see [documentation](https://docs.sonarsource.com/sonarqube/9.9/analyzing-source-code/scanners/sonarscanner/#running-from-zip-file)).
 This means that analysis properties provided that way should be prepended with `-D`, for instance:
 
 ```
-$ sonar-scanner-python -Dsonar.login=myAuthenticationToken FIXME -- The actual command name is not yet defined. Refer to PYSCAN-35
+$ pysonar -Dsonar.login=myAuthenticationToken 
 ```
 
 You can use all the argument allowed by __SonarScanner__. 
@@ -69,13 +69,13 @@ By default, the scanner will expect the `pyproject.toml` file to be present in t
 However, its path can be provided manually through the `toml.path` ([PYSCAN-40](https://sonarsource.atlassian.net/jira/software/c/projects/PYSCAN/issues/PYSCAN-40)) CLI argument as well as through the `sonar.projectHome` argument. For instance:
 
 ```
-sonar-scanner-python -Dtoml.path="path/to/pyproject.toml"
+pysonar -Dtoml.path="path/to/pyproject.toml"
 ```
 
 Or:
 
 ```
-sonar-scanner-python -Dsonar.projectHome="path/to/projectHome"
+pysonar -Dsonar.projectHome="path/to/projectHome"
 ```
 
 
@@ -117,7 +117,7 @@ It is also possible to define configure the scanner through environment variable
 
 ```
 $ export SONAR_HOST_URL="http://localhost:9000"
-$ sonar-scanner-python FIXME -- The actual command name is not yet defined. Refer to PYSCAN-35
+$ pysonar 
 ```
 
 See the __SonarScanner__ [documentation](https://docs.sonarsource.com/sonarqube/9.9/analyzing-source-code/scanners/sonarscanner/) for more information.
@@ -135,7 +135,7 @@ Install poetry with `pipx install poetry`
 
 # Run the main script
 
-Run `python src/py_sonar_scanner`
+Run `python src/pysonar`
 
 # Run the tests
 

its/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 # PYSCAN-35: Decide on definitive package name
-name = "py-sonar-scanner-its"
+name = "pysonar-its"
 version = "0.0.1"
 authors = [
   "Guillaume Dequenne <[email protected]>",
@@ -45,7 +45,7 @@ black = ">=23.12.0"
 pytest = ">=7.4.3"
 pytest-docker = ">=2.0.1"
 requests = "2.31.0"
-py-sonar-scanner = { "path" = "../" }
+pysonar = { "path" = "../" }
 
 [[tool.poetry.source]]
 name = "repox"

its/utils/cli_client.py

@@ -25,7 +25,7 @@
 
 class CliClient():
 
-    SCANNER_CMD: str = "py-sonar-scanner"
+    SCANNER_CMD: str = "pysonar"
     SOURCES_FOLDER_PATH: str = os.path.join(
         os.path.dirname(__file__), "../sources")
 

pyproject.toml

@@ -3,8 +3,7 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-# PYSCAN-35: Decide on definitive package name
-name = "py-sonar-scanner"
+name = "pysonar"
 version = "0.0.6"
 authors = [
   "Guillaume Dequenne <[email protected]>",
@@ -35,7 +34,7 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
   "Topic :: Software Development :: Quality Assurance",
 ]
-packages = [{ include = "py_sonar_scanner", from = "src" }]
+packages = [{ include = "pysonar", from = "src" }]
 
 [tool.poetry.dependencies]
 python = ">=3.8"
@@ -57,7 +56,7 @@ Homepage = "https://github.com/SonarSource/sonar-scanner-python"
 Repository = "https://github.com/SonarSource/sonar-scanner-python"
 
 [tool.poetry.scripts]
-"py-sonar-scanner" = "py_sonar_scanner.__main__:scan"
+"pysonar" = "pysonar.__main__:scan"
 
 [tool.poetry.group.dev.dependencies]
 coverage = ">=7.3.3"

src/py_sonar_scanner/__init__.py renamed to src/pysonar/__init__.py

@@ -17,9 +17,9 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
-from py_sonar_scanner.configuration import Configuration
-from py_sonar_scanner.environment import Environment
-from py_sonar_scanner.logger import ApplicationLogger
+from pysonar.configuration import Configuration
+from pysonar.environment import Environment
+from pysonar.logger import ApplicationLogger
 
 
 def scan():

src/py_sonar_scanner/__main__.py renamed to src/pysonar/__main__.py

@@ -27,7 +27,7 @@
 
 import toml
 
-from py_sonar_scanner.logger import ApplicationLogger
+from pysonar.logger import ApplicationLogger
 
 
 class Configuration:

src/py_sonar_scanner/configuration.py renamed to src/pysonar/configuration.py

@@ -25,10 +25,10 @@
 import urllib.request
 from urllib.error import HTTPError
 
-from py_sonar_scanner.logger import ApplicationLogger
-from py_sonar_scanner.configuration import Configuration
-from py_sonar_scanner.utils.binaries_utils import write_binaries, unzip_binaries
-from py_sonar_scanner.scanner import Scanner
+from pysonar.logger import ApplicationLogger
+from pysonar.configuration import Configuration
+from pysonar.utils.binaries_utils import write_binaries, unzip_binaries
+from pysonar.scanner import Scanner
 
 systems = {"Darwin": "macosx", "Windows": "windows"}
 

src/py_sonar_scanner/environment.py renamed to src/pysonar/environment.py

@@ -22,8 +22,8 @@
 from threading import Thread
 from subprocess import Popen, PIPE
 
-from py_sonar_scanner.logger import ApplicationLogger
-from py_sonar_scanner.configuration import Configuration
+from pysonar.logger import ApplicationLogger
+from pysonar.configuration import Configuration
 
 
 class Scanner: