You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ There are two GrimoireLab components involved in data retrieval:
40
40
41
41
* Perceval provides the common API for the many different kinds of repositories. It is a Python library that can be used standalone, from your own code, or in combination with other GrimoireLab components, to store data so that it can be analyzed later. Perceval also knows how to negotiate with the repositories APIs to perform incremental retrieval. That allows for continuous updates of recent data from the repository, retrieving only the increment, in a way that is transparent to the library user.
42
42
43
-
* Arthur organizes the data retrieval from repositories. It uses a queing system to provide retrieval jobs as an abstraction. Each retrieval job, which corresponds to data retrieval from a specific repository, can run in a different node. Data queues provide an API very similar to Perceval, with the same data structures. Arthur is usually used as a library by code consuming the retrieved data. Arthur uses Perceval for access to the repositories.
43
+
* Arthur organizes the data retrieval from repositories. It uses a queuing system to provide retrieval jobs as an abstraction. Each retrieval job, which corresponds to data retrieval from a specific repository, can run in a different node. Data queues provide an API very similar to Perceval, with the same data structures. Arthur is usually used as a library by code consuming the retrieved data. Arthur uses Perceval for access to the repositories.
Copy file name to clipboardExpand all lines: basics/components.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ The main components of GrimoireLab are:
18
18
* SortingHat. Manages identities for persons, including capabilities for merging the many identities corresponding to the same person, and other data related to them (such as affiliation to companies).
19
19
* Kibiter. Visualization platform. It is a soft fork of Kibana, which allows for the construction of actionable dashboards to show the data in enriched indexes.
20
20
* Sigils. Definition of Kibiter dashboards. They encode the panels, visualizations and other details needed to produce dashboards in Kibiter or Kibana.
21
-
*Manuscritps. Production of PDF documents reporting on the main characteristics of a project.
21
+
*Manuscripts. Production of PDF documents reporting on the main characteristics of a project.
22
22
* Mordred. Manages the configuration of all the components needed to produce a dashboard, automating its production.
Copy file name to clipboardExpand all lines: basics/install.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
## Installing GrimoireLab Python modules
2
2
3
3
Most of GrimoireLab are Python modules. The easiest way of installing them is using `pip3`,
4
-
which will retrieve the corresponding packages from the [Python Package Index](https://pypi.python.org/), and will automatically install them, including their dependecies (other Python packages that they need).
4
+
which will retrieve the corresponding packages from the [Python Package Index](https://pypi.python.org/), and will automatically install them, including their dependencies (other Python packages that they need).
5
5
6
-
Although it is not needed, we recomend using [Python virtual environments](https://docs.python.org/3/tutorial/venv.html) for installing packages. Below, you can find a section on how to prepare vitual packages in Python3, and then how to install GrimoireLab modules in them. If you are not interested in virtual environments, and know what you are doing, you can skip that part. Only remember, in that case, that it is very likely that you will need to prefix with `sudo` any installation command, to install, as root, in the default location in your system, instead of in a virtual environment.
6
+
Although it is not needed, we recommend using [Python virtual environments](https://docs.python.org/3/tutorial/venv.html) for installing packages. Below, you can find a section on how to prepare virtual packages in Python3, and then how to install GrimoireLab modules in them. If you are not interested in virtual environments, and know what you are doing, you can skip that part. Only remember, in that case, that it is very likely that you will need to prefix with `sudo` any installation command, to install, as root, in the default location in your system, instead of in a virtual environment.
7
7
8
8
Most of this section is about installing the packages that are available from
9
9
[Pypi](http://pypi.python.org),
@@ -51,7 +51,7 @@ You can also have several different virtual environments, each with different se
51
51
52
52
### Installing tools in the virtual environment
53
53
54
-
Depending on what you have installed in your system, it may be convenient to install some Python tools in it, and to upgrade some others. We recommend that you type, in your activated virtual ennvironment:
54
+
Depending on what you have installed in your system, it may be convenient to install some Python tools in it, and to upgrade some others. We recommend that you type, in your activated virtual environment:
55
55
56
56
```bash
57
57
(gl) $ pip3 install --upgrade pip
@@ -82,7 +82,7 @@ In the following sections, we will explain how to install,
82
82
separately, some of the GrimoireLab modules.
83
83
Of course, they can be installed in separate virtual environments.
84
84
But this is needed only if the `grimoirelab` package was not installed,
85
-
and you want to install only some of the modueles.
85
+
and you want to install only some of the modules.
86
86
87
87
### Installing Perceval
88
88
@@ -205,7 +205,7 @@ dulwich/_objects.c:21:10: fatal error: Python.h: No such file or Directory
205
205
206
206
Previous instructions are for installing the Python packages corresponding to the GrimoireLab coordinated releases. These packages are supposed to be stable and tested. But if you prefer to live in the edge, you can also install directly from development repositories. To easy this case, there is a little utility: [build_grimoirelab](https://github.com/chaoss/grimoirelab/blob/master/utils/build_grimoirelab).
207
207
208
-
> **Warning:** latest versions in development repositories may be instable, not play well with each other, or even not work at all. Use at your own risk.
208
+
> **Warning:** latest versions in development repositories may be unstable, not play well with each other, or even not work at all. Use at your own risk.
209
209
210
210
It is designed to work standalone, with just a few dependencies. It is easy to produce a Python virtual environment with all GrimoireLab tools (and dependencies) installed, corresponding to the latest version in the master branch of each of the development repositories. Just the utility, and run:
`build_grimoirelab` can also be used to create a virtual enviroment with a specific release of GrimoireLab installed. For that, download the release file (which specifies the versions of each tool) from the
227
+
`build_grimoirelab` can also be used to create a virtual environment with a specific release of GrimoireLab installed. For that, download the release file (which specifies the versions of each tool) from the
228
228
[releases directory](https://github.com/chaoss/grimoirelab/tree/master/releases) and run (assuming you downloaded the release file `elasticgirl.21` to the current directory):
Copy file name to clipboardExpand all lines: manuscripts/first.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ It uses data from GrimoireLab indexes in ElasticSearch, and produces PDF documen
8
8
9
9
Reporting with GrimoireLab Manuscripts is easy. You need to have enriched ElasticSearch indexes, produced by GrimoireELK (see [Producing Kibana dashboards with GrimoireELK](/grimoireelk/intro.md)) or Mordred (see [Mordred: orchestrating everything](/mordred/intro.md)), and of course, having `grimoirelab-manuscripts` installed. The rest is pretty easy.
10
10
11
-
For example, to produce a report about Git data in the standard GrimoireLab enriched index in my local ElasticSearch (accesible in the standard [http://localhost:9200](http://localhost:9200) location), you only need to run:
11
+
For example, to produce a report about Git data in the standard GrimoireLab enriched index in my local ElasticSearch (accessible in the standard [http://localhost:9200](http://localhost:9200) location), you only need to run:
0 commit comments