# pyadm - Swiss Army Knife for Engineers and Administrators
**pyadm** is a versatile command-line tool designed as a Swiss Army Knife for engineers and administrators.\
It provides modular functionality to perform various tasks efficiently.
**Currently, the only available module is `ldap`, which enables LDAP-related operations.**
## Installation
To install `pyadm`, use the following command (soon!):
```shell
pip install pyadm-toolkit
```
## Usage
The general command structure for pyadm is as follows:
```shell
pyadm MODULE SUBCOMMAND [OPTIONS]
```
To use the LDAP module, execute the pyadm ldap command followed by the desired subcommand to perform specific LDAP operations.
## LDAP Module
The LDAP module within pyadm allows you to interact with LDAP servers and perform common operations, such as retrieving user information, showing group associations, and displaying group members.
### Examples
* Retrieve information for a user in the LDAP directory:
```shell
pyadm ldap user USERNAME
```
* Show groups associated with a user in the LDAP directory:
```shell
pyadm ldap groups USERNAME
```
* Show members of a group in the LDAP directory:
```shell
pyadm ldap members GROUP_CN
```
For more information on each subcommand, you can use the --help option, as shown in the examples below:
```shell
pyadm ldap user --help
pyadm ldap groups --help
pyadm ldap members --hel
```
## Configuration
The pyadm tool allows you to customize its behavior through a configuration file. By default, the configuration file is located at `~/.config/pyadm/pyadm.conf`.
To use a custom configuration file, create a file in the following format:
```ini
[LDAP]
server = ldaps://dc.example.org
base_dn = dc=example,dc=org
bind_username = administrator@example.org
bind_password = s3cr3t-p455w0rd!
```
Specify the desired values for the LDAP server, base DN, bind username, and bind password in the configuration file.
## Contributing
Contributions are welcome! If you encounter any issues, have suggestions, or would like to add new features, please submit an issue or a pull request.
## License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\
Feel free to copy and use this markdown source as needed for your `README.md` file.
Raw data
{
"_id": null,
"home_page": "https://github.com/okleinschmidt/pyadm",
"name": "pyadm-toolkit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10.8",
"maintainer_email": "",
"keywords": "python admin toolkit pyadm ldap activedirectory directoryserver",
"author": "Ole Kleinschmidt",
"author_email": "Ole Kleinschmidt <ok@datenreisende.org>",
"download_url": "https://files.pythonhosted.org/packages/6e/d0/c9d446d879c49be0485b8155a8d4804920850e722a56c18fe53333f54d01/pyadm-toolkit-0.0.1.tar.gz",
"platform": null,
"description": "# pyadm - Swiss Army Knife for Engineers and Administrators\n\n**pyadm** is a versatile command-line tool designed as a Swiss Army Knife for engineers and administrators.\\\nIt provides modular functionality to perform various tasks efficiently. \n\n**Currently, the only available module is `ldap`, which enables LDAP-related operations.**\n\n## Installation\n\nTo install `pyadm`, use the following command (soon!):\n\n```shell\npip install pyadm-toolkit\n```\n## Usage\nThe general command structure for pyadm is as follows:\n```shell\npyadm MODULE SUBCOMMAND [OPTIONS]\n```\nTo use the LDAP module, execute the pyadm ldap command followed by the desired subcommand to perform specific LDAP operations.\n\n## LDAP Module\nThe LDAP module within pyadm allows you to interact with LDAP servers and perform common operations, such as retrieving user information, showing group associations, and displaying group members.\n\n### Examples\n* Retrieve information for a user in the LDAP directory:\n ```shell\n pyadm ldap user USERNAME\n ```\n* Show groups associated with a user in the LDAP directory:\n ```shell\n pyadm ldap groups USERNAME\n ```\n* Show members of a group in the LDAP directory:\n ```shell\n pyadm ldap members GROUP_CN\n ```\nFor more information on each subcommand, you can use the --help option, as shown in the examples below:\n```shell\npyadm ldap user --help\npyadm ldap groups --help\npyadm ldap members --hel\n```\n\n## Configuration\nThe pyadm tool allows you to customize its behavior through a configuration file. By default, the configuration file is located at `~/.config/pyadm/pyadm.conf`.\n\nTo use a custom configuration file, create a file in the following format:\n```ini\n[LDAP]\nserver = ldaps://dc.example.org\nbase_dn = dc=example,dc=org\nbind_username = administrator@example.org\nbind_password = s3cr3t-p455w0rd!\n```\nSpecify the desired values for the LDAP server, base DN, bind username, and bind password in the configuration file.\n\n## Contributing\nContributions are welcome! If you encounter any issues, have suggestions, or would like to add new features, please submit an issue or a pull request.\n\n## License\nThis project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\\\nFeel free to copy and use this markdown source as needed for your `README.md` file.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "PyADM - Python Admin Toolkit. The swiss army knife for every engineer.",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/okleinschmidt/pyadm/issues",
"Homepage": "https://github.com/okleinschmidt/pyadm"
},
"split_keywords": [
"python",
"admin",
"toolkit",
"pyadm",
"ldap",
"activedirectory",
"directoryserver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f1e74911dd84303d16b10c19612d28ad879a9c447ddf5f92f813e4ded8ab3af",
"md5": "8556da714ba0487cca55374fa60c8409",
"sha256": "dbf90c2cd9df214ced948cf7246b97bc6707e60f7cbf6d96ba7d84cf62cfdd63"
},
"downloads": -1,
"filename": "pyadm_toolkit-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8556da714ba0487cca55374fa60c8409",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.8",
"size": 7081,
"upload_time": "2023-07-17T20:56:32",
"upload_time_iso_8601": "2023-07-17T20:56:32.016929Z",
"url": "https://files.pythonhosted.org/packages/8f/1e/74911dd84303d16b10c19612d28ad879a9c447ddf5f92f813e4ded8ab3af/pyadm_toolkit-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ed0c9d446d879c49be0485b8155a8d4804920850e722a56c18fe53333f54d01",
"md5": "12fd0172129371a65378ed81c401443b",
"sha256": "f24573a3262bedb61659d92a747ce645a8114252f7e028bdf76d3bf7a348b996"
},
"downloads": -1,
"filename": "pyadm-toolkit-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "12fd0172129371a65378ed81c401443b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.8",
"size": 6956,
"upload_time": "2023-07-17T20:56:33",
"upload_time_iso_8601": "2023-07-17T20:56:33.715575Z",
"url": "https://files.pythonhosted.org/packages/6e/d0/c9d446d879c49be0485b8155a8d4804920850e722a56c18fe53333f54d01/pyadm-toolkit-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-17 20:56:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "okleinschmidt",
"github_project": "pyadm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "click",
"specs": []
},
{
"name": "ldap3",
"specs": []
}
],
"lcname": "pyadm-toolkit"
}
JSON
