# 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](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](https://python-poetry.org/) for dependency management and
packaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).
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.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "sortinghat-openinfra",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab, sortinghat",
"author": "Bitergia Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c1/d9/6a697b46c1c76100fa64f22bd3aec027faa1cf2c1721d33f7e3db2ee3ff2/sortinghat_openinfra-0.1.23.tar.gz",
"platform": null,
"description": "# sortinghat-openinfra\n\nSortingHat backend to import identities from OpenInfraID\n\n## Requirements\n\n * Python >= 3.8\n\nYou will also need some other libraries for running the tool, you can find the\nwhole list of dependencies in [pyproject.toml](pyproject.toml) file.\n\n## Installation\n\nThere are several ways to install sortinghat-openinfra on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nsortinghat-openinfra can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install sortinghat-openinfra\n```\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n```\n$ git clone https://github.com/bitergia-analytics/sortinghat-openinfra\n$ cd sortinghat-openinfra\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\nTo install the package from local directory run the following command:\n```\n$ pip install .\n```\nIn case you are a developer, you should install sortinghat-openinfra in editable mode:\n```\n$ pip install -e .\n```\n\n## Usage\n\nInstall this SortingHat backend to import identities from OpenInfraID. You can\nuse this importer using the API or the UI. The name of the backend is \n`OpenInfraID`. You need to provide the URL in the importer configuration,\ntypically `https://openstackid-resources.openstack.org`.\n\nBy default, this backend only obtain members from the public API that doesn't\ncontain email information. If you want to obtain members emails you need\nto define the following configuration variables in your settings file:\n- `OPENINFRA_CLIENT_ID`: OpenInfraID Oauth2 client ID for private API.\n- `OPENINFRA_CLIENT_SECRET`: OpenInfraID Oauth2 client secret for private API.\n\n#### Poetry\nWe use [poetry](https://python-poetry.org/) for dependency management and \npackaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).\nOnce you have installed it, you can install sortinghat-openinfra and the dependencies in \na project isolated environment using:\n```\n$ poetry install\n```\nTo spaw a new shell within the virtual environment use:\n```\n$ poetry shell\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "SortingHat backend to import identities from OpenInfraID",
"version": "0.1.23",
"project_urls": {
"Bug Tracker": "https://github.com/bitergia-analytics/sortinghat-openinfra/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/bitergia-analytics/sortinghat-openinfra"
},
"split_keywords": [
"development",
" grimoirelab",
" sortinghat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49d8aa14632cc25861a175605411fa2c4e273aff54f79987fdf5a14a93260faa",
"md5": "88203c624fcef8a7cfaa76f7396d45d6",
"sha256": "d80301a128ac301fd5125bc2536061e7577a30038ebea7f64276bc2208f86916"
},
"downloads": -1,
"filename": "sortinghat_openinfra-0.1.23-py3-none-any.whl",
"has_sig": false,
"md5_digest": "88203c624fcef8a7cfaa76f7396d45d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 17714,
"upload_time": "2024-05-09T13:04:04",
"upload_time_iso_8601": "2024-05-09T13:04:04.281639Z",
"url": "https://files.pythonhosted.org/packages/49/d8/aa14632cc25861a175605411fa2c4e273aff54f79987fdf5a14a93260faa/sortinghat_openinfra-0.1.23-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1d96a697b46c1c76100fa64f22bd3aec027faa1cf2c1721d33f7e3db2ee3ff2",
"md5": "160aecae908c37d6383528ed8598632d",
"sha256": "5a3d1a02b24fc925119f06f5fd421f780d8fb8a19050bdecfe7f9bc8fd23021c"
},
"downloads": -1,
"filename": "sortinghat_openinfra-0.1.23.tar.gz",
"has_sig": false,
"md5_digest": "160aecae908c37d6383528ed8598632d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 22563,
"upload_time": "2024-05-09T13:04:06",
"upload_time_iso_8601": "2024-05-09T13:04:06.002337Z",
"url": "https://files.pythonhosted.org/packages/c1/d9/6a697b46c1c76100fa64f22bd3aec027faa1cf2c1721d33f7e3db2ee3ff2/sortinghat_openinfra-0.1.23.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 13:04:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bitergia-analytics",
"github_project": "sortinghat-openinfra",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sortinghat-openinfra"
}
JSON
