<!--
SPDX-FileCopyrightText: 2024 DB Systel GmbH
SPDX-License-Identifier: Apache-2.0
-->
# GitHub Organization Manager
[](https://github.com/OpenRailAssociation/github-org-manager/actions/workflows/test.yaml)
[](https://api.reuse.software/info/github.com/OpenRailAssociation/github-org-manager)
[](https://pypi.org/project/github-org-manager/)
[](https://pypi.org/project/github-org-manager/)
A lightweight tool that helps with managing a GitHub organization, its members, teams, repository permissions and more.
The basic principle: all settings reside in YAML configuration files which will be made effective during a run of this tool.
## Features
* Manage GitHub teams and their members and maintainers
* Support of sub-teams
* Manage teams' permissions on organizations' repositories
* Invite members to the organization if they aren't part of it yet
* Warn about unmanaged teams
* Warn about organization members who are not part of any team
Are you missing a feature? Please check whether it's [already posted as an issue](https://github.com/OpenRailAssociation/github-org-manager/issues), and create one of this isn't the case.
## Install
Dependencies: Python 3.10 or newer
To install: `pip3 install github-org-manager`
You may also want to consider using helpers such as [`pipx`](https://pipx.pypa.io/) to avoid a dependency mess on your system.
Afterwards, the tool is executable with the command `gh-org-mgr`. The `--help` flag informs you about the required and available commands.
## Configuration
Inside [`config/example`](./config/example), you can find an example configuration that shall help you to understand the structure:
* `app.yaml`: Configuration necessary to run this tool
* `org.yaml`: Organization-wide configuration
* `teams/*.yaml`: Configuration concerning the teams of your organization.
You may also be interested in the [live configuration of the OpenRail Association's organization](https://github.com/OpenRailAssociation/openrail-org-config).
## Run the program
You can execute the program using the command `gh-org-mgr`. `gh-org-mgr --help` shows all available arguments and options.
Synchronisation examples:
* `gh-org-mgr sync -c myorgconf`: synchronize the settings of the GitHub organization with your local configuration in the given configuration path (`myorgconf`). This may create new teams, remove/add members, and change permissions.
* `gh-org-mgr sync -c myorgconf --dry`: as above, but do not make any modification. Perfect for testing your local configuration and see its potential effects.
* `gh-org-mgr sync -c myorgconf --debug`: the first example, but show full debugging information.
Setup team examples:
* `gh-org-mgr setup-team -n "My Team Name" -c myorgconf`: Bootstrap a team configuration for this team name. Will create a file `myorgconf/teams/my-team-name.yaml`, or provide options if this file already exists.
* `gh-org-mgr setup-team -n "My Team Name" -f path/to/myteam.yaml`: Bootstrap a team configuration for this team name and will force to write it in the given file. If the file already exists, offer some options.
## License
The content of this repository is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
There may be components under different, but compatible licenses or from different copyright holders. The project is REUSE compliant which makes these portions transparent. You will find all used licenses in the [LICENSES](./LICENSES/) directory.
The project is has been started by the [OpenRail Association](https://openrailassociation.org). You are welcome to [contribute](./CONTRIBUTING.md)!
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenRailAssociation/github-org-manager",
"name": "github-org-manager",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "github, github-management, permissions, access-control",
"author": "Max Mehl",
"author_email": "max.mehl@deutschebahn.com",
"download_url": "https://files.pythonhosted.org/packages/a8/db/95402ef1583fa77847fcddd1c415660a08b849c487ceb6480e09026ac543/github_org_manager-0.4.1.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2024 DB Systel GmbH\n\nSPDX-License-Identifier: Apache-2.0\n-->\n\n# GitHub Organization Manager\n\n[](https://github.com/OpenRailAssociation/github-org-manager/actions/workflows/test.yaml)\n[](https://api.reuse.software/info/github.com/OpenRailAssociation/github-org-manager)\n[](https://pypi.org/project/github-org-manager/)\n[](https://pypi.org/project/github-org-manager/)\n\nA lightweight tool that helps with managing a GitHub organization, its members, teams, repository permissions and more.\n\nThe basic principle: all settings reside in YAML configuration files which will be made effective during a run of this tool.\n\n## Features\n\n* Manage GitHub teams and their members and maintainers\n* Support of sub-teams\n* Manage teams' permissions on organizations' repositories\n* Invite members to the organization if they aren't part of it yet\n* Warn about unmanaged teams\n* Warn about organization members who are not part of any team\n\nAre you missing a feature? Please check whether it's [already posted as an issue](https://github.com/OpenRailAssociation/github-org-manager/issues), and create one of this isn't the case.\n\n## Install\n\nDependencies: Python 3.10 or newer\n\nTo install: `pip3 install github-org-manager`\n\nYou may also want to consider using helpers such as [`pipx`](https://pipx.pypa.io/) to avoid a dependency mess on your system.\n\nAfterwards, the tool is executable with the command `gh-org-mgr`. The `--help` flag informs you about the required and available commands.\n\n## Configuration\n\nInside [`config/example`](./config/example), you can find an example configuration that shall help you to understand the structure:\n\n* `app.yaml`: Configuration necessary to run this tool\n* `org.yaml`: Organization-wide configuration\n* `teams/*.yaml`: Configuration concerning the teams of your organization.\n\nYou may also be interested in the [live configuration of the OpenRail Association's organization](https://github.com/OpenRailAssociation/openrail-org-config).\n\n## Run the program\n\nYou can execute the program using the command `gh-org-mgr`. `gh-org-mgr --help` shows all available arguments and options.\n\nSynchronisation examples:\n\n* `gh-org-mgr sync -c myorgconf`: synchronize the settings of the GitHub organization with your local configuration in the given configuration path (`myorgconf`). This may create new teams, remove/add members, and change permissions.\n* `gh-org-mgr sync -c myorgconf --dry`: as above, but do not make any modification. Perfect for testing your local configuration and see its potential effects.\n* `gh-org-mgr sync -c myorgconf --debug`: the first example, but show full debugging information.\n\nSetup team examples:\n\n* `gh-org-mgr setup-team -n \"My Team Name\" -c myorgconf`: Bootstrap a team configuration for this team name. Will create a file `myorgconf/teams/my-team-name.yaml`, or provide options if this file already exists.\n* `gh-org-mgr setup-team -n \"My Team Name\" -f path/to/myteam.yaml`: Bootstrap a team configuration for this team name and will force to write it in the given file. If the file already exists, offer some options.\n\n## License\n\nThe content of this repository is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).\n\nThere may be components under different, but compatible licenses or from different copyright holders. The project is REUSE compliant which makes these portions transparent. You will find all used licenses in the [LICENSES](./LICENSES/) directory.\n\nThe project is has been started by the [OpenRail Association](https://openrailassociation.org). You are welcome to [contribute](./CONTRIBUTING.md)!\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Manage a GitHub Organization, its teams, repository permissions, and more",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/OpenRailAssociation/github-org-manager",
"Repository": "https://github.com/OpenRailAssociation/github-org-manager"
},
"split_keywords": [
"github",
" github-management",
" permissions",
" access-control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "292f6ceeb9aece73ae8604fc345ea9a2478fd68983dfe8be3b9736faf2f23873",
"md5": "8f6d63fb677f9002c2334e248bc1a4e6",
"sha256": "104ac7d85a30abb037ceca6ac96d3e1584599e3e5f98e2ebdf7b1fed9aba7e7d"
},
"downloads": -1,
"filename": "github_org_manager-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f6d63fb677f9002c2334e248bc1a4e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 35301,
"upload_time": "2024-08-21T09:25:55",
"upload_time_iso_8601": "2024-08-21T09:25:55.789919Z",
"url": "https://files.pythonhosted.org/packages/29/2f/6ceeb9aece73ae8604fc345ea9a2478fd68983dfe8be3b9736faf2f23873/github_org_manager-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8db95402ef1583fa77847fcddd1c415660a08b849c487ceb6480e09026ac543",
"md5": "e8d7e7ba01eb1f756d3027b617081336",
"sha256": "fce71dc264dc9fe31a7a51b6ae001edf2b991c6a09a81f21c12290c346c07911"
},
"downloads": -1,
"filename": "github_org_manager-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "e8d7e7ba01eb1f756d3027b617081336",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 28281,
"upload_time": "2024-08-21T09:25:58",
"upload_time_iso_8601": "2024-08-21T09:25:58.929559Z",
"url": "https://files.pythonhosted.org/packages/a8/db/95402ef1583fa77847fcddd1c415660a08b849c487ceb6480e09026ac543/github_org_manager-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 09:25:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenRailAssociation",
"github_project": "github-org-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "github-org-manager"
}
JSON
