PYSCAN-69 Rename scanner to pysonar-scanner (#69)

Author: ghislainpiot

.cirrus.yml

@@ -158,6 +158,6 @@ promote_task:
     BURGR_URL: VAULT[development/kv/data/burgr data.url]
     BURGR_USERNAME: VAULT[development/kv/data/burgr data.cirrus_username]
     BURGR_PASSWORD: VAULT[development/kv/data/burgr data.cirrus_password]
-    ARTIFACTS: :pysonar:tar.gz,:pysonar:whl:py3-none-any
+    ARTIFACTS: :pysonar_scanner:tar.gz,:pysonar_scanner:whl:py3-none-any
   <<: *POETRY_TEMPLATE
   promote_script: cirrus_promote

CONTRIBUTING.md

@@ -11,7 +11,7 @@ Install poetry with `pipx install poetry`
 
 # Run the main script
 
-Run `python src/pysonar`
+Run `python src/pysonar_scanner`
 
 # Run the tests
 

README.md

@@ -1,4 +1,4 @@
-# pysonar
+# pysonar-scanner
 A wrapper around SonarScanner CLI, available on PyPI.
 
 # Disclaimer 
@@ -15,34 +15,34 @@ These changes include configuration parameter names.
 
 Install with pip:
 ```
-pip install pysonar
+pip install pysonar-scanner
 ```
 
 # Usage
 
-Once installed, the `pysonar` can be run from the command line to perform an analysis.
+Once installed, the `pysonar-scanner` 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 `pysonar` command
+* Through CLI arguments to the `pysonar-scanner` 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 `pysonar` command.
+Analysis properties can be provided as CLI arguments to the `pysonar-scanner` 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:
 
 ```
-$ pysonar -Dsonar.login=myAuthenticationToken 
+$ pysonar-scanner -Dsonar.login=myAuthenticationToken 
 ```
 
 You can use all the argument allowed by __SonarScanner__. 
@@ -79,13 +79,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:
 
 ```
-pysonar -Dtoml.path="path/to/pyproject.toml"
+pysonar-scanner -Dtoml.path="path/to/pyproject.toml"
 ```
 
 Or:
 
 ```
-pysonar -Dsonar.projectHome="path/to/projectHome"
+pysonar-scanner -Dsonar.projectHome="path/to/projectHome"
 ```
 
 
@@ -127,7 +127,7 @@ It is also possible to define configure the scanner through environment variable
 
 ```
 $ export SONAR_HOST_URL="http://localhost:9000"
-$ pysonar 
+$ pysonar-scanner 
 ```
 
 See the __SonarScanner__ [documentation](https://docs.sonarsource.com/sonarqube/9.9/analyzing-source-code/scanners/sonarscanner/) for more information.
@@ -137,7 +137,7 @@ See the __SonarScanner__ [documentation](https://docs.sonarsource.com/sonarqube/
 To install the latest pre-released version of Sonar Scanner Python. Execute the following command: 
 
 ```shell
-pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pysonar
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pysonar-scanner
 ```
 
 # License

its/poetry.lock

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 # PYSCAN-35: Decide on definitive package name
-name = "pysonar-its"
+name = "pysonar-scanner-its"
 version = "0.0.1"
 authors = ['Python Squad <[email protected]>']
 description = "Integration tests for Sonar Scanner for the Python Ecosystem"
@@ -40,7 +40,7 @@ black = ">=23.12.0"
 pytest = ">=7.4.3"
 pytest-docker = ">=2.0.1"
 requests = "2.31.0"
-pysonar = { "path" = "../" }
+pysonar-scanner = { "path" = "../" }
 
 [[tool.poetry.source]]
 name = 'jfrog-server'

its/pyproject.toml

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

its/utils/cli_client.py

@@ -23,7 +23,7 @@ classifiers = ['Environment :: Console', 'Intended Audience :: Developers', 'Ope
 description = 'Sonar Scanner for the Python Ecosystem'
 keywords = ['sonar', 'sonarqube', 'sonarcloud', 'cleancode']
 license = 'LGPL-3.0-only'
-name = 'pysonar'
+name = 'pysonar-scanner'
 readme = 'README.md'
 version = '0.1.0'
 
@@ -45,10 +45,10 @@ pytest-cov = '>=4.1.0'
 
 [[tool.poetry.packages]]
 from = 'src'
-include = 'pysonar'
+include = 'pysonar_scanner'
 
 [tool.poetry.scripts]
-pysonar = 'pysonar.__main__:scan'
+pysonar-scanner = 'pysonar_scanner.__main__:scan'
 
 [[tool.poetry.source]]
 name = 'jfrog-server'

pyproject.toml

@@ -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 pysonar.configuration import Configuration
-from pysonar.environment import Environment
-from pysonar.logger import ApplicationLogger
+from pysonar_scanner.configuration import Configuration
+from pysonar_scanner.environment import Environment
+from pysonar_scanner.logger import ApplicationLogger
 
 
 def scan():

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

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