sortinghat-openinfra 0.1.15rc1

SortingHat backend to import identities from OpenInfraID

sortinghat-openinfra

SortingHat backend to import identities from OpenInfraID

Requirements

• Python >= 3.8

You will also need some other libraries for running the tool, you can find the whole list of dependencies in pyproject.toml file.

Installation

There are several ways to install sortinghat-openinfra on your system: packages or source code using Poetry or pip.

PyPI

sortinghat-openinfra can be installed using pip, a tool for installing Python packages. To do it, run the next command:

$ pip install sortinghat-openinfra

Source code

To install from the source code you will need to clone the repository first:

$ git clone https://github.com/bitergia-analytics/sortinghat-openinfra
$ cd sortinghat-openinfra

Then use pip or Poetry to install the package along with its dependencies.

Pip

To install the package from local directory run the following command:

$ pip install .

In case you are a developer, you should install sortinghat-openinfra in editable mode:

$ pip install -e .

Usage

Install this SortingHat backend to import identities from OpenInfraID. You can use this importer using the API or the UI. The name of the backend is OpenInfraID. You need to provide the URL in the importer configuration, typically https://openstackid-resources.openstack.org.

By default, this backend only obtain members from the public API that doesn't contain email information. If you want to obtain members emails you need to define the following configuration variables in your settings file:

• OPENINFRA_CLIENT_ID: OpenInfraID Oauth2 client ID for private API.
• OPENINFRA_CLIENT_SECRET: OpenInfraID Oauth2 client secret for private API.

Poetry

We use poetry for dependency management and packaging. You can install it following its documentation. Once you have installed it, you can install sortinghat-openinfra and the dependencies in a project isolated environment using:

$ poetry install

To spaw a new shell within the virtual environment use:

$ poetry shell

License

Licensed under GNU General Public License (GPL), version 3 or later.