Skip to content

Commit 2567ca2

Browse files
committed
[install] Add non-Python dependencies
In some cases, some non-Python packages may be needed. This patch includes some notes about that.
1 parent e31d049 commit 2567ca2

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

basics/install.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ If you want to install the latest version available in the development
1212
repositories, have a look at
1313
[Installing from development repositories](#repos).
1414

15+
You may need to have some other non-Python packages installed previously. Please check the [section on installing non-Python packages](#non-python-pkgs) if you have any trouble.
16+
1517

1618
### Preparing a virtualenv {#venvs}
1719

@@ -181,6 +183,23 @@ Once it is installed with its dependencies, try it with:
181183
(gl) $ sirmordred --help
182184
```
183185

186+
### Installation of non-Python packages {#non-python-pkgs}
187+
188+
Some of GrimoireLab dependencies need non-Python packages as pre-requisites to be installed. Make sure that you have them installed in your system before running the Python installation commands above:
189+
190+
* For `dulwich` to be installed, you need to have some Python libraries present. In Debian-derived systems (such as Ubuntu), that can be done by installing the `python3-dev` package:
191+
192+
```
193+
$ sudo apt-get install python3-dev
194+
```
195+
196+
Usually, you know you need this when you have a problem installing `dulwich`. For example, you check the output of `pip install` and you find:
197+
198+
```
199+
dulwich/_objects.c:21:10: fatal error: Python.h: No such file or Directory
200+
```
201+
202+
`Python.h` is one of the files provided by the `python3-dev` Debian package, which includes development libraries and files needed to compile Python-related code.
184203

185204
### Installing from development repositories {#repos}
186205

0 commit comments

Comments
 (0)