# sortinghat-eclipse-foundation
SortingHat backend to import identities from Eclipse Foundation
## Requirements
- Python >= 3.9
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-eclipse-foundation on your system: packages or source
code using Poetry or pip.
### PyPI
sortinghat-eclipse-foundation can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install sortinghat-eclipse-foundation
```
### Source code
To install from the source code you will need to clone the repository first:
```
$ git clone https://github.com/bitergia-analytics/sortinghat-eclipse-foundation
$ cd sortinghat-eclipse-foundation
```
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-eclipse-foundation in editable mode:
```
$ pip install -e .
```
#### 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
```
## Usage
Install this SortingHat backend to import identities from the Eclipse Foundation.
You can use this importer using the API or the UI. The name of the backend is
`EclipseFoundation`. You will have to provide the credentials on the settings file
in order to access the Eclipse Foundation API:
- `ECLIPSE_FOUNDATION_USER_ID`: username on the Eclipse Foundation platform.
- `ECLIPSE_FOUNDATION_PASSWORD`: password for the previous user.
The user will also have the next permissions for reading the identities:
- `eclipsefdn_view_all_profiles`
Raw data
{
"_id": null,
"home_page": null,
"name": "sortinghat-eclipse-foundation",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "development, grimoirelab, sortinghat",
"author": "Bitergia Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/78/89/be9df4201b88d588bab8d8780ce05dc93d7ebf9d425eb24f4f350a21c74a/sortinghat_eclipse_foundation-0.1.0rc1.tar.gz",
"platform": null,
"description": "# sortinghat-eclipse-foundation\n\nSortingHat backend to import identities from Eclipse Foundation\n\n## Requirements\n\n - Python >= 3.9\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-eclipse-foundation on your system: packages or source\ncode using Poetry or pip.\n\n### PyPI\n\nsortinghat-eclipse-foundation can be installed using pip, a tool for installing Python packages.\nTo do it, run the next command:\n```\n$ pip install sortinghat-eclipse-foundation\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-eclipse-foundation\n$ cd sortinghat-eclipse-foundation\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\n\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-eclipse-foundation in editable mode:\n```\n$ pip install -e .\n```\n\n#### Poetry\n\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## Usage\n\nInstall this SortingHat backend to import identities from the Eclipse Foundation.\nYou can use this importer using the API or the UI. The name of the backend is\n`EclipseFoundation`. You will have to provide the credentials on the settings file\nin order to access the Eclipse Foundation API:\n\n- `ECLIPSE_FOUNDATION_USER_ID`: username on the Eclipse Foundation platform.\n- `ECLIPSE_FOUNDATION_PASSWORD`: password for the previous user.\n\nThe user will also have the next permissions for reading the identities:\n\n- `eclipsefdn_view_all_profiles`\n",
"bugtrack_url": null,
"license": null,
"summary": "SortingHat backend to import identities from the Eclipse Foundation",
"version": "0.1.0rc1",
"project_urls": null,
"split_keywords": [
"development",
" grimoirelab",
" sortinghat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ad9d51a13644772473e715bfaab34409b81300203e245d72d2be66e8b6bf870",
"md5": "034023e9fd93d63d8233535ad2d69e43",
"sha256": "f3109a12396cb60c2f529ef6b4596ba39bb972ba7f622c93c1737b1f4feee2a4"
},
"downloads": -1,
"filename": "sortinghat_eclipse_foundation-0.1.0rc1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "034023e9fd93d63d8233535ad2d69e43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 9953,
"upload_time": "2025-08-26T14:42:20",
"upload_time_iso_8601": "2025-08-26T14:42:20.630937Z",
"url": "https://files.pythonhosted.org/packages/6a/d9/d51a13644772473e715bfaab34409b81300203e245d72d2be66e8b6bf870/sortinghat_eclipse_foundation-0.1.0rc1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7889be9df4201b88d588bab8d8780ce05dc93d7ebf9d425eb24f4f350a21c74a",
"md5": "56a92b47a90ab47f20c72a719e203762",
"sha256": "5a7438df40a096a1fd4f98e8fe3caf51024f817d77009a62a4986ac1459a36de"
},
"downloads": -1,
"filename": "sortinghat_eclipse_foundation-0.1.0rc1.tar.gz",
"has_sig": false,
"md5_digest": "56a92b47a90ab47f20c72a719e203762",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 12003,
"upload_time": "2025-08-26T14:42:21",
"upload_time_iso_8601": "2025-08-26T14:42:21.825213Z",
"url": "https://files.pythonhosted.org/packages/78/89/be9df4201b88d588bab8d8780ce05dc93d7ebf9d425eb24f4f350a21c74a/sortinghat_eclipse_foundation-0.1.0rc1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 14:42:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sortinghat-eclipse-foundation"
}
JSON