{"id":15853963,"url":"https://github.com/allamand/pwdc","last_synced_at":"2025-04-01T18:49:54.936Z","repository":{"id":57455614,"uuid":"80726431","full_name":"allamand/pwdc","owner":"allamand","description":"A simple python CLI for your on-premise Play With Docker instance","archived":false,"fork":false,"pushed_at":"2017-02-02T17:30:41.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-09T13:36:54.235Z","etag":null,"topics":["client","python"],"latest_commit_sha":null,"homepage":null,"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/allamand.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-02T13:17:23.000Z","updated_at":"2017-02-02T17:25:38.000Z","dependencies_parsed_at":"2022-09-05T19:21:45.051Z","dependency_job_id":null,"html_url":"https://github.com/allamand/pwdc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allamand%2Fpwdc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allamand%2Fpwdc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allamand%2Fpwdc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allamand%2Fpwdc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allamand","download_url":"https://codeload.github.com/allamand/pwdc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246695295,"owners_count":20819245,"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":["client","python"],"created_at":"2024-10-05T19:40:26.972Z","updated_at":"2025-04-01T18:49:54.916Z","avatar_url":"https://github.com/allamand.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"pwd-cli\n=========\n\n*A simple python CLI for your on-premise instance of Play With Docker*\n\n\n*Create a 5 node Cluster Swarm in 5 seconds!*\n\n\nPurpose\n-------\n\nThis is a CLI that allows you to create, connecte to, view, and delete \ninstances of Play-With-Docker.\n\n- You Need to have an instance of [Play-With-Docker](https://github.com/franela/play-with-docker) without the Capcha test.\n\nThe Goal of this project is to allow you or your users to quickly create ready to uses clusters swarm, and uses it without\nleaving your terminal.\n\nInstallation\n------------\n\nThe easiest way is to install from Pypi library::\n\n    $ pip install pwdc\n\n\nUsage\n-----\n\nYou can just uses the following commands to create and use your cluster::\n\n    $ pwdc init --pwd-url=http://\u003cyour-pwd-server\u003e\n\nInitialise the pwdc configuration file in ~/.pwdc.\nYou need to update the ~/.pwdc value with the url of your PWD instance if not given the `--pwd-url` parameter::\n\n    $ pwdc create\n\nThis will uses the PWD instance from your `~/.pwdc` file, then :\n\n- create a PWD session\n- create 5 nodes\n- init a swarm with a master on node1\n- join the swarm from the node2 to node5\n- provides informations on your cluster\n\nThe Cluster is ready to uses, just point your docker CLI on the new Swarm::\n\n\n    $ eval $(pwdc env)\n    $ docker info\n\n\nFrom then, you can manipulaite the swarm cluster with your docker or docker-compose CLI::\n\n    $ pwdc info\n\nShow you the informations about your PWD session.\n\n\nYou can have multiple PWD session, this is manage with the `--session_file` parameter, which locally store your PWD session informations.\n\n\nAfter a while, the session will be aumatically deleted, but you can also delete it manually when you are done with your session::\n\n    $ pwdc delete\n    $ eval $(pwdc env -u)\n\nthe last eval if to reset your docker client config\n\n\n\nContribution\n------------\n\nIf you've cloned this project, and want to install the library (*and all\ndevelopment dependencies*), the command you'll want to run is::\n\n    $ pip install -e .[test]\n\nIf you'd like to run all tests for this project (*assuming you've written\nsome*), you would run the following command::\n\n    $ python setup.py test\n\nThis will trigger `py.test \u003chttp://pytest.org/latest/\u003e`_, along with its popular\n`coverage \u003chttps://pypi.python.org/pypi/pytest-cov\u003e`_ plugin.\n\nLastly, if you'd like to cut a new release of this CLI tool, and publish it to\nthe Python Package Index (`PyPI \u003chttps://pypi.python.org/pypi\u003e`_), you can do so\nby running::\n\n    $ python setup.py sdist bdist_wheel\n    $ twine upload dist/*\n\nThis will build both a source tarball of your CLI tool, as well as a newer wheel\nbuild (*and this will, by default, run on all platforms*).\n\nThe ``twine upload`` command (which requires you to install the `twine\n\u003chttps://pypi.python.org/pypi/twine\u003e`_ tool) will then securely upload your\nnew package to PyPI so everyone in the world can use it!\n\n\n\nCrédit\n------\n\nThis Works is based on the [skele-cli](https://github.com/rdegges/skele-cli) python cli project skeleton\nand uses the powerfull opensource project [Play-With-Docker](https://github.com/franela/play-with-docker).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallamand%2Fpwdc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallamand%2Fpwdc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallamand%2Fpwdc/lists"}