docker-run-docker-ros


Namedocker-run-docker-ros JSON
Version 1.0.5 PyPI version JSON
download
home_pageNone
Summarydocker-run plugin for Docker images built by docker-ros
upload_time2024-04-09 11:31:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT License Copyright (c) 2023 Institute for Automotive Engineering (ika), RWTH Aachen University Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords docker container ros
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # docker-run-docker-ros

[`docker-run`](https://pypi.org/project/docker-run/) plugin for Docker images built by [*docker-ros*](https://github.com/ika-rwth-aachen/docker-ros).

## Installation

```bash
pip install docker-run[docker-ros]
```

## Usage

```
usage: docker-run [--help] [--image IMAGE] [--mwd] [--mws] [--name NAME]
                  [--no-gpu] [--no-it] [--no-loc] [--no-name] [--no-rm]
                  [--no-tz] [--no-user] [--no-x11] [--verbose] [--version]

Executes `docker run` with the following features enabled by default, each of
which can be disabled individually: container removal after exit, interactive
tty, current directory name as container name, GPU support, X11 GUI
forwarding. Passes any additional arguments to `docker run`. Executes `docker
exec` instead if a container with the specified name (`--name`) is already
running.

optional arguments:
  --help         show this help message and exit
  --image IMAGE  image name (may also be specified without --image as last
                 argument before command)
  --mwd          mount current directory at same path
  --mws          [docker-ros] mount current directory into ROS workspace at
                 `/docker-ros/ws/src/target`
  --name NAME    container name; generates `docker exec` command if already
                 running
  --no-gpu       disable automatic GPU support
  --no-it        disable automatic interactive tty
  --no-loc       disable automatic locale
  --no-name      disable automatic container name (current directory)
  --no-rm        disable automatic container removal
  --no-tz        disable automatic timezone
  --no-user      [docker-ros] disable passing local UID/GID into container
  --no-x11       disable automatic X11 GUI forwarding
  --verbose      print generated command
  --version      show program's version number and exit
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "docker-run-docker-ros",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Lennart Reiher <lennart.reiher@rwth-aachen.de>, Jean-Pierre Busch <jean-pierre.busch@rwth-aachen.de>",
    "keywords": "docker, container, ros",
    "author": null,
    "author_email": "Lennart Reiher <lennart.reiher@rwth-aachen.de>, Jean-Pierre Busch <jean-pierre.busch@rwth-aachen.de>",
    "download_url": "https://files.pythonhosted.org/packages/47/80/f9a401885201b336489407eef4a5205d9a61e15f689f321f665579d5e40a/docker-run-docker-ros-1.0.5.tar.gz",
    "platform": null,
    "description": "# docker-run-docker-ros\n\n[`docker-run`](https://pypi.org/project/docker-run/) plugin for Docker images built by [*docker-ros*](https://github.com/ika-rwth-aachen/docker-ros).\n\n## Installation\n\n```bash\npip install docker-run[docker-ros]\n```\n\n## Usage\n\n```\nusage: docker-run [--help] [--image IMAGE] [--mwd] [--mws] [--name NAME]\n                  [--no-gpu] [--no-it] [--no-loc] [--no-name] [--no-rm]\n                  [--no-tz] [--no-user] [--no-x11] [--verbose] [--version]\n\nExecutes `docker run` with the following features enabled by default, each of\nwhich can be disabled individually: container removal after exit, interactive\ntty, current directory name as container name, GPU support, X11 GUI\nforwarding. Passes any additional arguments to `docker run`. Executes `docker\nexec` instead if a container with the specified name (`--name`) is already\nrunning.\n\noptional arguments:\n  --help         show this help message and exit\n  --image IMAGE  image name (may also be specified without --image as last\n                 argument before command)\n  --mwd          mount current directory at same path\n  --mws          [docker-ros] mount current directory into ROS workspace at\n                 `/docker-ros/ws/src/target`\n  --name NAME    container name; generates `docker exec` command if already\n                 running\n  --no-gpu       disable automatic GPU support\n  --no-it        disable automatic interactive tty\n  --no-loc       disable automatic locale\n  --no-name      disable automatic container name (current directory)\n  --no-rm        disable automatic container removal\n  --no-tz        disable automatic timezone\n  --no-user      [docker-ros] disable passing local UID/GID into container\n  --no-x11       disable automatic X11 GUI forwarding\n  --verbose      print generated command\n  --version      show program's version number and exit\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Institute for Automotive Engineering (ika), RWTH Aachen University  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "docker-run plugin for Docker images built by docker-ros",
    "version": "1.0.5",
    "project_urls": {
        "Bug Tracker": "https://github.com/ika-rwth-aachen/docker-run/issues",
        "Repository": "https://github.com/ika-rwth-aachen/docker-run"
    },
    "split_keywords": [
        "docker",
        " container",
        " ros"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d69f0cf091da0e3b6c68c18ead0c30e0de2333edb0dfb89f9155034e8184991",
                "md5": "8357a2b969a00e00dda26c0b560db5d4",
                "sha256": "1a2daf2d638b47361231f3307b55e60cdc22daaab71c087de77471b06f4ad2d2"
            },
            "downloads": -1,
            "filename": "docker_run_docker_ros-1.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8357a2b969a00e00dda26c0b560db5d4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4557,
            "upload_time": "2024-04-09T11:31:11",
            "upload_time_iso_8601": "2024-04-09T11:31:11.319770Z",
            "url": "https://files.pythonhosted.org/packages/7d/69/f0cf091da0e3b6c68c18ead0c30e0de2333edb0dfb89f9155034e8184991/docker_run_docker_ros-1.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4780f9a401885201b336489407eef4a5205d9a61e15f689f321f665579d5e40a",
                "md5": "fbfa995bc1671e4a67cce8934fc87b77",
                "sha256": "d3b32497398d565dea90778c4f1851ce18a1f785809b2ea7833130610631391b"
            },
            "downloads": -1,
            "filename": "docker-run-docker-ros-1.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "fbfa995bc1671e4a67cce8934fc87b77",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3716,
            "upload_time": "2024-04-09T11:31:12",
            "upload_time_iso_8601": "2024-04-09T11:31:12.501939Z",
            "url": "https://files.pythonhosted.org/packages/47/80/f9a401885201b336489407eef4a5205d9a61e15f689f321f665579d5e40a/docker-run-docker-ros-1.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-09 11:31:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ika-rwth-aachen",
    "github_project": "docker-run",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "docker-run-docker-ros"
}
        
Elapsed time: 0.43876s