{"id":13819408,"url":"https://github.com/cea-hpc/clustershell","last_synced_at":"2025-05-14T13:06:14.175Z","repository":{"id":2622564,"uuid":"3607283","full_name":"cea-hpc/clustershell","owner":"cea-hpc","description":"Scalable cluster administration Python framework — Manage node sets, node groups and execute commands on cluster nodes in parallel.","archived":false,"fork":false,"pushed_at":"2025-02-23T06:39:28.000Z","size":9607,"stargazers_count":436,"open_issues_count":115,"forks_count":86,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-04-13T13:13:35.587Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://clustershell.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cea-hpc.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","contributing":null,"funding":null,"license":"COPYING.LGPLv2.1","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-03-02T23:51:18.000Z","updated_at":"2025-03-21T21:22:30.000Z","dependencies_parsed_at":"2024-05-28T07:26:18.135Z","dependency_job_id":"47d5e004-cb62-42e0-a61d-f1463db8c616","html_url":"https://github.com/cea-hpc/clustershell","commit_stats":{"total_commits":827,"total_committers":31,"mean_commits":"26.677419354838708","dds":0.407496977025393,"last_synced_commit":"4f6df52d56789dbdd416a824e72a0a393df351fe"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cea-hpc%2Fclustershell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cea-hpc%2Fclustershell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cea-hpc%2Fclustershell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cea-hpc%2Fclustershell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cea-hpc","download_url":"https://codeload.github.com/cea-hpc/clustershell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254149950,"owners_count":22022851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T08:00:47.149Z","updated_at":"2025-05-14T13:06:14.073Z","avatar_url":"https://github.com/cea-hpc.png","language":"Python","readme":"ClusterShell Python Library and Tools\n=====================================\n\nClusterShell is an event-driven open source Python library, designed to run\nlocal or distant commands in parallel on server farms or on large Linux\nclusters. It will take care of common issues encountered on HPC clusters, such\nas operating on groups of nodes, running distributed commands using optimized\nexecution algorithms, as well as gathering results and merging identical\noutputs, or retrieving return codes. ClusterShell takes advantage of existing\nremote shell facilities already installed on your systems, like SSH.\n\nClusterShell's primary goal is to improve the administration of high-\nperformance clusters by providing a lightweight but scalable Python API for\ndevelopers. It also provides clush, clubak and cluset/nodeset, convenient\ncommand-line tools that allow traditional shell scripts to benefit from some\nof the library features.\n\nRequirements\n------------\n\n * GNU/Linux, BSD, Mac OS X\n * OpenSSH (ssh/scp) or rsh\n * Python 2.x (x \u003e= 7) or Python 3.x (x \u003e= 6)\n * PyYAML\n\nLicense\n-------\n\nClusterShell is distributed under the GNU Lesser General Public License version\n2.1 or later (LGPL v2.1+). Read the file `COPYING.LGPLv2.1` for details.\n\nDocumentation\n-------------\n\nOnline documentation is available here:\n\n    http://clustershell.readthedocs.org/\n\nThe Sphinx documentation source is available under the doc/sphinx directory.\nType 'make' to see all available formats (you need Sphinx installed and\nsphinx_rtd_theme to build the documentation). For example, to generate html\ndocs, just type:\n\n    make html BUILDDIR=/dest/path\n\nFor local library API documentation, just type:\n\n    $ pydoc ClusterShell\n\nThe following man pages are also provided:\n\n    clush(1), clubak(1), nodeset(1), clush.conf(5), groups.conf(5)\n\nTest Suite\n----------\n\nRegression testing scripts are available in the 'tests' directory:\n\n    $ cd tests\n    $ nosetests -sv \u003cTest.py\u003e\n    $ nosetests -sv --all-modules\n\nYou have to allow 'ssh localhost' and 'ssh $HOSTNAME' without any warnings for\n\"remote\" tests to run as expected. $HOSTNAME should not be 127.0.0.1 nor ::1.\nAlso some tests use the 'bc' command.\n\nPython code (simple example)\n----------------------------\n\n```python\n\u003e\u003e\u003e from ClusterShell.Task import task_self\n\u003e\u003e\u003e from ClusterShell.NodeSet import NodeSet\n\u003e\u003e\u003e task = task_self()\n\u003e\u003e\u003e task.run(\"/bin/uname -r\", nodes=\"linux[4-6,32-39]\")\n\u003cClusterShell.Worker.Ssh.WorkerSsh object at 0x20a5e90\u003e\n\u003e\u003e\u003e for buf, key in task.iter_buffers():\n...     print NodeSet.fromlist(key), buf\n... \nlinux[32-39] 2.6.40.6-0.fc15.x86_64\n\nlinux[4-6] 2.6.32-71.el6.x86_64\n```\n\nLinks\n-----\n\nWeb site:\n\n    http://cea-hpc.github.com/clustershell/\n\nOnline documentation:\n\n    http://clustershell.readthedocs.org/\n\nGithub source repository:\n\n    https://github.com/cea-hpc/clustershell\n\nGithub Wiki:\n\n    https://github.com/cea-hpc/clustershell/wiki\n\nGithub Issue tracking system:\n\n    https://github.com/cea-hpc/clustershell/issues\n\nPython Package Index (PyPI) links:\n\n    https://pypi.org/project/ClusterShell/\n\n    http://pypi.python.org/pypi/ClusterShell\n\nClusterShell was born along with Shine, a scalable Lustre FS admin tool:\n\n    https://github.com/cea-hpc/shine\n\nCore developers/reviewers\n-------------------------\n\n* Stephane Thiell\n* Aurelien Degremont\n* Henri Doreau\n* Dominique Martinet\n\nCEA/DAM 2010, 2011, 2012, 2013, 2014, 2015 - http://www-hpc.cea.fr\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcea-hpc%2Fclustershell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcea-hpc%2Fclustershell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcea-hpc%2Fclustershell/lists"}