Skip to content

Commit d52bd3c

Browse files
Update doc to build sonar-python (#955)
1 parent a27efa0 commit d52bd3c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@
1010

1111
## Building the project
1212

13-
sonar-python embeds [Typeshed](https://github.com/python/typeshed) as a Git submodule. Prior to building the project, you should therefore run `git submodule update --init` to retrieve the corresponding sources.
13+
Maven build is generating protobuf messages for Typeshed symbols from a python script (see [typeshed_serializer](https://github.com/SonarSource/sonar-python/tree/master/python-frontend/typeshed_serializer)).
14+
In order for it to work properly it needs to have Python runtime and [Typeshed](https://github.com/python/typeshed) available.
15+
16+
### Prerequisites
17+
- Run `git submodule update --init` to retrieve [Typeshed](https://github.com/python/typeshed) as a Git submodule
18+
- Make sure to have Python 3.9 and [tox](https://tox.readthedocs.io/en/latest/) installed and available in PATH
19+
20+
### Profiles
21+
22+
- `mvn clean install` : execute full build, run tests for [typeshed_serializer](https://github.com/SonarSource/sonar-python/tree/master/python-frontend/typeshed_serializer)
23+
- `mvn clean install -DskipTypeshed`: avoid running [typeshed_serializer](https://github.com/SonarSource/sonar-python/tree/master/python-frontend/typeshed_serializer) tests and build only Java maven modules
1424

1525
## License
1626

17-
Copyright 2011-2018 SonarSource.
27+
Copyright 2011-2021 SonarSource.
1828

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

0 commit comments

Comments
 (0)