Skip to content

Commit 7679f69

Browse files
authored
PYSCAN-56(docs): Correct license generation year and remove unused sections (#44)
1 parent 15165c0 commit 7679f69

File tree

1 file changed

+12
-19
lines changed

1 file changed

+12
-19
lines changed

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -139,21 +139,19 @@ Run `python src/pysonar`
139139

140140
# Run the tests
141141

142-
Run `poetry install` to install the dependencies. By default, the dependencies are installed from the Repox private repository.
142+
Run `poetry install` to install the dependencies. By default, the dependencies are installed from the Jfrog private repository.
143143

144-
To configure your credentials for Repox, go to your Repox user profile, and generate an identity token. Then set the following two environment variables:
145-
```markdown
146-
export POETRY_HTTP_BASIC_REPOX_USERNAME=<username>
147-
export POETRY_HTTP_BASIC_REPOX_PASSWORD=<password>
144+
To configure your credentials for Jfrog, go to your Jfrog user profile, and generate an identity token. Then set the following two environment variables:
145+
```shell
146+
poetry config http-basic.jfrog-server <username> <password>
148147
```
149-
Where `<username>` is your Repox username and `<password>` is the identity token you generated.
148+
Where `<username>` is your Jfrog username and `<password>` is the identity token you generated.
150149

151-
If you wish to install the dependencies from the public PyPI repository, remove the following from `pyproject.toml`:
150+
If you wish to install the dependencies from the public PyPI repository, remove the following source from `pyproject.toml`:
152151
```toml
153152
[[tool.poetry.source]]
154-
name = "repox"
155-
url = "https://repox.jfrog.io/artifactory/api/pypi/sonarsource-pypi/simple/"
156-
priority = "default"
153+
name = 'jfrog-server'
154+
url = 'https://repox.jfrog.io/artifactory/api/pypi/sonarsource-pypi/simple'
157155
```
158156

159157
## Run the tests only
@@ -175,12 +173,7 @@ The binaries will be located in the `dist` directory at the root level of the pr
175173

176174
# Publish the script
177175

178-
Run if needed `python3 -python3 -m pip install --upgrade twine` to upgrade to the latest version of twine
179-
180-
Run `python3 -m twine upload --repository testpypi dist/*`
181-
182-
`--repository testpypi` can be removed to push to the prod PyPI instance.
183-
Also `dist/*` can be a bit more precise to upload a specific version of the binaries
176+
Create a GitHub release.
184177

185178
# Update the package version
186179

@@ -210,12 +203,12 @@ Run `poetry run mypy src/ tests/ --ignore-missing-imports` to execute the type c
210203
Before pushing, please check if all files have a license header.
211204
If not all files have a license header please execute:
212205
```
213-
poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py -d src/
214-
poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py -d tests/
206+
poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d src/
207+
poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d tests/
215208
```
216209

217210
# License
218211

219-
Copyright 2011-2023 SonarSource.
212+
Copyright 2011-2024 SonarSource.
220213

221214
Licensed under the [GNU Lesser General Public License, Version 3.0](http://www.gnu.org/licenses/lgpl.txt)

0 commit comments

Comments
 (0)