# ☎️ EDRN LDAP Sync
This package contains utilities for the dirctory service of the [EDRN](https://edrn.nci.nih.gov/). There are three console scripts provided:
- `usersync` — adds and removes users from the EDRN RDF feed for registered people
- `groupsync` — adds and updates funded sites and collaborative groups from the EDRN RDF feeds for sites and committees
- `all-edrn-sync` — keeps the `All EDRN` group up-to-date
## 🚗 Getting Started
Do something like the following:
```console
$ python3 -m venv venv
$ venv/bin/pip install --quiet --upgrade setuptools pip wheel
$ venv/bin/pip install --editable .
```
and you should be good to go to run the three scripts mentioned above out of `venv/bin`.
## 🎥 Production Use
Just add a crontab entry like the following:
```crontab
@daily /usr/local/edrn/edrn/ldap-sync-utils/bin/usersync --password PASSWORD --quiet
@daily /usr/local/edrn/edrn/ldap-sync-utils/bin/groupsync --password PASSWORD --quiet
@hourly /usr/local/edrn/edrn/ldap-sync-utils/bin/all-edrn-sync --password PASSWORD --quiet
```
replacing PASSWORD with the password of the manager account of the EDRN Directory Service.
## 📀 Software Environment
This is written in Python 3 and requires Python 3.7 or later (but probably not Python 4 or later).
### 👥 Contributing
You can start by looking at the [open issues](https://github.com/EDRN/jpl.edrn.ldap.sync/issues), forking the project, and submitting a pull request. You can also [contact us by email](mailto:ic-portal@jpl.nasa.gov) with suggestions.
### 🔢 Versioning
We use the [SemVer](https://semver.org/) philosophy for versioning this software. For versions available, see the [releases made](https://github.com/EDRN/jpl.edrn.ldap.sync/releases) on this project.
## 👩🎨 Creators
The principal developer is:
- [Sean Kelly](https://github.com/nutjob4life)
## 📃 License
The project is licensed under the [Apache version 2](LICENSE.md) license.
Raw data
{
"_id": null,
"home_page": "https://github.com/EDRN/jpl.edrn.ldap.sync",
"name": "jpl.edrn.ldap.sync",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ldap directory cancer",
"author": "Sean Kelly",
"author_email": "kelly@seankelly.biz",
"download_url": "https://files.pythonhosted.org/packages/6c/dc/a28f9a173aab6f6276184ca04c3d95811808dcf8ebe1be590c0697618a33/jpl_edrn_ldap_sync-2.0.2.tar.gz",
"platform": null,
"description": "# \u260e\ufe0f\u00a0EDRN LDAP Sync\n\nThis package contains utilities for the dirctory service of the [EDRN](https://edrn.nci.nih.gov/). There are three console scripts provided:\n\n- `usersync` \u2014 adds and removes users from the EDRN RDF feed for registered people\n- `groupsync` \u2014 adds and updates funded sites and collaborative groups from the EDRN RDF feeds for sites and committees\n- `all-edrn-sync` \u2014 keeps the `All EDRN` group up-to-date\n\n\n## \ud83d\ude97\u00a0Getting Started\n\nDo something like the following:\n\n```console\n$ python3 -m venv venv\n$ venv/bin/pip install --quiet --upgrade setuptools pip wheel\n$ venv/bin/pip install --editable .\n```\n\nand you should be good to go to run the three scripts mentioned above out of `venv/bin`.\n\n\n## \ud83c\udfa5\u00a0Production Use\n\nJust add a crontab entry like the following:\n\n```crontab\n@daily /usr/local/edrn/edrn/ldap-sync-utils/bin/usersync --password PASSWORD --quiet\n@daily /usr/local/edrn/edrn/ldap-sync-utils/bin/groupsync --password PASSWORD --quiet\n@hourly /usr/local/edrn/edrn/ldap-sync-utils/bin/all-edrn-sync --password PASSWORD --quiet\n```\nreplacing PASSWORD with the password of the manager account of the EDRN Directory Service.\n\n\n## \ud83d\udcc0\u00a0Software Environment\n\nThis is written in Python 3 and requires Python 3.7 or later (but probably not Python 4 or later).\n\n\n### \ud83d\udc65\u00a0Contributing\n\nYou can start by looking at the [open issues](https://github.com/EDRN/jpl.edrn.ldap.sync/issues), forking the project, and submitting a pull request. You can also [contact us by email](mailto:ic-portal@jpl.nasa.gov) with suggestions.\n\n\n### \ud83d\udd22\u00a0Versioning\n\nWe use the [SemVer](https://semver.org/) philosophy for versioning this software. For versions available, see the [releases made](https://github.com/EDRN/jpl.edrn.ldap.sync/releases) on this project.\n\n\n## \ud83d\udc69\u200d\ud83c\udfa8\u00a0Creators\n\nThe principal developer is:\n\n- [Sean Kelly](https://github.com/nutjob4life)\n\n\n## \ud83d\udcc3\u00a0License\n\nThe project is licensed under the [Apache version 2](LICENSE.md) license.\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "LDAP utilities for the Early Detection Research Network Directory",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/EDRN/jpl.edrn.ldap.sync"
},
"split_keywords": [
"ldap",
"directory",
"cancer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80076e27e558cb03621c703df63ae56ba30bc8e25fd9d0b69a509547d97b07c6",
"md5": "a71f134c7ba6a1b907583e861b26d213",
"sha256": "2baf70f4c947fff14daa58ff9f51fc1de00b521c0c031de6867ec88296f82bf8"
},
"downloads": -1,
"filename": "jpl.edrn.ldap.sync-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a71f134c7ba6a1b907583e861b26d213",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18391,
"upload_time": "2024-05-02T22:16:13",
"upload_time_iso_8601": "2024-05-02T22:16:13.716451Z",
"url": "https://files.pythonhosted.org/packages/80/07/6e27e558cb03621c703df63ae56ba30bc8e25fd9d0b69a509547d97b07c6/jpl.edrn.ldap.sync-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6cdca28f9a173aab6f6276184ca04c3d95811808dcf8ebe1be590c0697618a33",
"md5": "e144af754a26bbfcffe7c46b14f9fc14",
"sha256": "4d74cb6b72fd29c5610bb0a3b10767d059215c87d2fac56a1237fd0f09ddc7b8"
},
"downloads": -1,
"filename": "jpl_edrn_ldap_sync-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "e144af754a26bbfcffe7c46b14f9fc14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15467,
"upload_time": "2024-05-02T22:16:15",
"upload_time_iso_8601": "2024-05-02T22:16:15.004614Z",
"url": "https://files.pythonhosted.org/packages/6c/dc/a28f9a173aab6f6276184ca04c3d95811808dcf8ebe1be590c0697618a33/jpl_edrn_ldap_sync-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 22:16:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EDRN",
"github_project": "jpl.edrn.ldap.sync",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jpl.edrn.ldap.sync"
}
JSON
