{ "info": { "author": "2degrees", "author_email": "2degrees-floss@googlegroups.com", "bugtrack_url": null, "classifiers": [], "description": "# Development tool for Docker and Docker Compose\n\n`docker-dev` eases common tasks involving Docker and Docker Compose in\ndevelopment. **Its primary feature is to namespace Docker Compose projects** so\nthat you can easily have one project for each branch in your repository.\n\nDocker Compose projects are given a name, which default to that of the project\ndirectory. This name is then prefixed to the Docker resources (e.g., images,\ncontainers) created for the Docker Compose project.\n\n`docker-dev` extends the project name to include the active branch name, and\nthen proxies calls to `docker-compose` so that they refer to the new project\nname. For example, if your project is called \"foo\" and your active Git branch\nis \"master\", the Docker Compose project name will be set to \"foo-master\".\n\nThis tool is available on PYPI as\n[docker-dev](https://pypi.python.org/pypi/docker-dev).\n\n## Features\n\n- Maintain isolated Docker Compose projects for branches of the same VCS\n repository, even if they all share the same path. This means that\n `git checkout` will play nice with `docker-compose`.\n- Run host-level commands just before running `docker-compose build`. This is\n essential in some environments, such as Python where a `*.egg-info` directory\n must exist at the root of the project if you mount the path on the container\n to get instant code reload.\n- Easily run your test suites and export their output to the host. For example,\n you can use this to expose your test reports to your Continuous Integration\n Service.\n\n## Development\n\n`docker-dev` proxies the `docker-compose` sub-commands `build`, `up` and `down`:\n\n- `docker-dev build` will run all the pre-build hooks that you have\n installed (see below) and it'll also pull the latest version of any base\n images before actually building the images.\n- `docker-dev up` ensures that you get new containers on each call.\n- `docker-dev down` ensures that no trace of your project is left in Docker\n (inc. images, containers and volumes).\n\n## Testing\n\n`docker-dev test` allows you to run test suites and export their output to the\nhost system. It requires a Docker Compose file (`testing.dc.yml` by default)\nthat defines all the services responsible for running the tests.\n\nEach test service has to begin with \"test-\" and must place its output in\n`/tmp/test-reports`, as the contents of this directory will later be exported to\nthe host. Here's an example of a Docker Compose file for testing:\n\n```yaml\nversion: \"2\"\nservices:\n test-main:\n build: \".\"\n command: \"test-runner --output-dir=/tmp/test-reports\"\n```\n\nTo prevent a name clash, the suffix \"-test\" is added to the Docker Compose\nproject name when run.\n\nNo traces are left in Docker after this command is run, not even when the tests\nfail.\n\n## Plugins\n\nThis tool can be extended via the following types of plugins.\n\n### Project Name Generator\n\nIf your Docker Compose project is in a Git repository, `docker-dev` will append\nthe active branch name to the name of the Docker Compose project. If you want\nto override this behaviour or add support for another VCS, you'd need to create\na function that computes the name; e.g.:\n\n```python\ndef get_project_name(docker_compose_file_path):\n return 'suffix'\n```\n\nFinally, you have to register that function in your project's `setup.py` file\nas an entry point for the group `docker_dev.project_name_generator`. E.g.,\n\n```python\nsetup(\n name='your-distribution',\n entry_points={\n 'docker_dev.project_name_generator': [\n 'foo = your_package:get_project_name',\n ],\n },\n)\n\n```\n\n### Pre-Build Hook\n\nTo have routines executed at the host level before building the images, you\ncan create a pre-build hook. For example:\n\n```python\ndef hook(docker_compose_file_path, project_name):\n run_some_commands()\n```\n\nThis function then has to be registered as an entry point, under the group\n`docker_dev.pre_build_hooks`.\n\n`docker-dev` will run all the installed pre-build hooks unconditionally.\n\nAs of this writing, only one plugin is available:\n[docker-dev-python](https://github.com/2degrees/docker-dev-python).\n\n## CLI\n\nFor an comprehensive and up-to-date description of the CLI, run\n`docker-dev --help`.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/2degrees/docker-dev", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "docker-dev", "package_url": "https://pypi.org/project/docker-dev/", "platform": "", "project_url": "https://pypi.org/project/docker-dev/", "project_urls": { "Homepage": "https://github.com/2degrees/docker-dev" }, "release_url": "https://pypi.org/project/docker-dev/1.0b2/", "requires_dist": null, "requires_python": "", "summary": "Development tools for Docker", "version": "1.0b2" }, "last_serial": 2913006, "releases": { "1.0a1": [], "1.0a2": [ { "comment_text": "", "digests": { "md5": "cfa8a572c50bb3a71e49b8cd4fcc0b4c", "sha256": "dd90b9257c82e3b37fbd47c12c77677d8e83ef8ca03b9c05774d03291cf75115" }, "downloads": -1, "filename": "docker_dev-1.0a2-py2-none-any.whl", "has_sig": false, "md5_digest": "cfa8a572c50bb3a71e49b8cd4fcc0b4c", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 11059, "upload_time": "2016-08-16T09:42:34", "url": "https://files.pythonhosted.org/packages/73/06/bed3111605f51720cd71a9b787110478397df2beb7d3259324f518dfd4f8/docker_dev-1.0a2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3ede8b51e3e965accd888a2ff408bb61", "sha256": "3b9feec40c07c3f249297a150a714cfe523e748023f41906e6e38f4bbb085e7d" }, "downloads": -1, "filename": "docker-dev-1.0a2.tar.gz", "has_sig": false, "md5_digest": "3ede8b51e3e965accd888a2ff408bb61", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5791, "upload_time": "2016-08-16T09:42:31", "url": "https://files.pythonhosted.org/packages/68/97/0c7db0d57cc9808d17fe4684df1c9da877e821fce441750615ed62871455/docker-dev-1.0a2.tar.gz" } ], "1.0a3": [], "1.0a4": [ { "comment_text": "", "digests": { "md5": "e07cc16fb2318b9377e10512ea2b69ab", "sha256": "968eca494cd608041fdbe9d5ca957152f8657a8c3688ebdb867fc2c3873666fd" }, "downloads": -1, "filename": "docker_dev-1.0a4-py2-none-any.whl", "has_sig": false, "md5_digest": "e07cc16fb2318b9377e10512ea2b69ab", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 14678, "upload_time": "2016-08-22T15:29:36", "url": "https://files.pythonhosted.org/packages/16/e7/32affa933ae3ed0278b3f16900fe0ab166056efdc75e45eb247a00c3762c/docker_dev-1.0a4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bbaec52b948ff8c6a6665897195478ec", "sha256": "402863487bbcf0c86726c17748535966d1d4737b0013ba279cdb8cd95e8b0bab" }, "downloads": -1, "filename": "docker-dev-1.0a4.tar.gz", "has_sig": false, "md5_digest": "bbaec52b948ff8c6a6665897195478ec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9695, "upload_time": "2016-08-22T15:29:34", "url": "https://files.pythonhosted.org/packages/7f/b1/ab0c7704b4c11942d543c923c975de31eeddd3d31731e95df64ab08d20b5/docker-dev-1.0a4.tar.gz" } ], "1.0a5": [ { "comment_text": "", "digests": { "md5": "46a72a5891795a120acc0ed32a7e1fae", "sha256": "9f88b0b6d34382741f0261d5e9f1bb7f19bfb0fd69fc65c4e97cc916ad068aec" }, "downloads": -1, "filename": "docker_dev-1.0a5-py2-none-any.whl", "has_sig": false, "md5_digest": "46a72a5891795a120acc0ed32a7e1fae", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 14664, "upload_time": "2016-08-22T15:43:44", "url": "https://files.pythonhosted.org/packages/51/fc/5d8f413ebec0a74b693722954fa7fae8b8c5d710983ca35d1d1e805788f2/docker_dev-1.0a5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a3920fdc39b430b7dac09e7291f97fb7", "sha256": "705a82fff2a2697308e239badeb780c4b69e4d5713a88f5fda053218b019e814" }, "downloads": -1, "filename": "docker-dev-1.0a5.tar.gz", "has_sig": false, "md5_digest": "a3920fdc39b430b7dac09e7291f97fb7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9683, "upload_time": "2016-08-22T15:43:41", "url": "https://files.pythonhosted.org/packages/58/eb/2706dcd9a8f0dc550834d49968af418c868c6b9974fe2438503b863a1253/docker-dev-1.0a5.tar.gz" } ], "1.0a6": [ { "comment_text": "", "digests": { "md5": "586e83a5f97f709ed9d4044b2b79dc06", "sha256": "62570623750cdc2ebf13e5ac3bc08cd96e1c18516089287e9ce6ee4d6c81f3fc" }, "downloads": -1, "filename": "docker_dev-1.0a6-py3-none-any.whl", "has_sig": false, "md5_digest": "586e83a5f97f709ed9d4044b2b79dc06", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 14419, "upload_time": "2016-08-24T09:14:24", "url": "https://files.pythonhosted.org/packages/b2/ee/257b1fff4f9a17aedcc4b4e3417516d39e6811b90c7b1f758619b67dcba6/docker_dev-1.0a6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "339bad6c0accee33b7cb61b81c73fe64", "sha256": "c832d1d72f8fc04e9a83e3b66b048683e125d0aa7c679916d4b1a262872904f2" }, "downloads": -1, "filename": "docker-dev-1.0a6.tar.gz", "has_sig": false, "md5_digest": "339bad6c0accee33b7cb61b81c73fe64", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7890, "upload_time": "2016-08-24T09:14:21", "url": "https://files.pythonhosted.org/packages/73/cb/754349f40fe335855b8d79c7993b25241d3ebdfc03b29fc8146ec817573c/docker-dev-1.0a6.tar.gz" } ], "1.0a7": [ { "comment_text": "", "digests": { "md5": "94854b1da7ad36590cad23a8d0357c44", "sha256": "305860ad4ec750da9ca8333603f1a45dfda5af044e81c54aad4e83af1035d2da" }, "downloads": -1, "filename": "docker_dev-1.0a7-py3-none-any.whl", "has_sig": false, "md5_digest": "94854b1da7ad36590cad23a8d0357c44", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 14286, "upload_time": "2016-09-01T08:35:33", "url": "https://files.pythonhosted.org/packages/93/7a/e8a77da7aa1bd9c169eff27f746dffd52f46a403ca5c5c486a825bb43a5c/docker_dev-1.0a7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6908cd1ead9d93eebeb7eb868611f461", "sha256": "e4faa1fcb74f7ff2f8a53c3d8682007eb53722a2e7a5232fa2ecf00867d50e12" }, "downloads": -1, "filename": "docker-dev-1.0a7.tar.gz", "has_sig": false, "md5_digest": "6908cd1ead9d93eebeb7eb868611f461", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7683, "upload_time": "2016-09-01T08:35:30", "url": "https://files.pythonhosted.org/packages/e1/79/eb33407b9096196014b214d4708bde12623247e63afd45ab95a6c1457ef9/docker-dev-1.0a7.tar.gz" } ], "1.0b1": [ { "comment_text": "", "digests": { "md5": "28bef404147c61eade6f848e6a9f3f1a", "sha256": "e5446879c7d9b5f0ac70c2865bc8a07141fe9b6cb5b3d508b60f72fe670c3993" }, "downloads": -1, "filename": "docker_dev-1.0b1-py3-none-any.whl", "has_sig": false, "md5_digest": "28bef404147c61eade6f848e6a9f3f1a", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 14054, "upload_time": "2017-05-26T12:46:47", "url": "https://files.pythonhosted.org/packages/a8/d4/2bdc8966658f3f5db2005742f8f24c587e5e8e2350816022c41abb28ec8c/docker_dev-1.0b1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a9916802a1540b9e834aa5f285732df", "sha256": "ad5e023447c88eb5fbdaca4a059b5cdd4c2d8a63241225c87c57ca2218467ac8" }, "downloads": -1, "filename": "docker-dev-1.0b1.tar.gz", "has_sig": false, "md5_digest": "0a9916802a1540b9e834aa5f285732df", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8985, "upload_time": "2017-05-26T12:46:46", "url": "https://files.pythonhosted.org/packages/73/91/d45bd4c210389a5dce297fb57886c907437ce5077e5184a1e50b02ae8a05/docker-dev-1.0b1.tar.gz" } ], "1.0b2": [ { "comment_text": "", "digests": { "md5": "835396c77cfac8a72557f689b5989073", "sha256": "3a420c63f1c51b2d3eb54b6df39b9a409ecc792eea890351757a5784de826f33" }, "downloads": -1, "filename": "docker_dev-1.0b2-py3-none-any.whl", "has_sig": false, "md5_digest": "835396c77cfac8a72557f689b5989073", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 14067, "upload_time": "2017-05-31T09:23:39", "url": "https://files.pythonhosted.org/packages/c6/dc/06ced3ca9dfa9265b9f31e2ef7d7695e56afdcf4debba10dd6ba0aa5b2f8/docker_dev-1.0b2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dcb541cee4ae9a26c0be61c494d5213b", "sha256": "d3780244e705a8d4df1429d1f8407322d2ade15f7a85e31540639e103202b712" }, "downloads": -1, "filename": "docker-dev-1.0b2.tar.gz", "has_sig": false, "md5_digest": "dcb541cee4ae9a26c0be61c494d5213b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8996, "upload_time": "2017-05-31T09:23:36", "url": "https://files.pythonhosted.org/packages/e0/48/8c096d29d1ed3c86928f584d5901625d2b4d4c63f6d623e672fc507af619/docker-dev-1.0b2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "835396c77cfac8a72557f689b5989073", "sha256": "3a420c63f1c51b2d3eb54b6df39b9a409ecc792eea890351757a5784de826f33" }, "downloads": -1, "filename": "docker_dev-1.0b2-py3-none-any.whl", "has_sig": false, "md5_digest": "835396c77cfac8a72557f689b5989073", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 14067, "upload_time": "2017-05-31T09:23:39", "url": "https://files.pythonhosted.org/packages/c6/dc/06ced3ca9dfa9265b9f31e2ef7d7695e56afdcf4debba10dd6ba0aa5b2f8/docker_dev-1.0b2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dcb541cee4ae9a26c0be61c494d5213b", "sha256": "d3780244e705a8d4df1429d1f8407322d2ade15f7a85e31540639e103202b712" }, "downloads": -1, "filename": "docker-dev-1.0b2.tar.gz", "has_sig": false, "md5_digest": "dcb541cee4ae9a26c0be61c494d5213b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8996, "upload_time": "2017-05-31T09:23:36", "url": "https://files.pythonhosted.org/packages/e0/48/8c096d29d1ed3c86928f584d5901625d2b4d4c63f6d623e672fc507af619/docker-dev-1.0b2.tar.gz" } ] }