{ "info": { "author": "Adam Charnock", "author_email": "adam@adamcharnock.com", "bugtrack_url": null, "classifiers": [], "description": "Heroku-like command line interface for `Dokku`_\n===============================================\n\n**Note:** This project is in the very early stages of development. \nYou can help by adding commands (see below).\n\n.. image:: https://badge.fury.io/py/dokku-client.png\n :target: https://badge.fury.io/py/dokku-client\n\n.. image:: https://pypip.in/d/dokku-client/badge.png\n :target: https://pypi.python.org/pypi/dokku-client\n\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install dokku-client\n\nConfiguration\n-------------\n\nYou can specify the Dokku host & app on the command line, but you may \nfind it convenient to set the following environment variables instead:\n\n.. code-block:: bash\n\n export DOKKU_HOST=ubuntu@myserver.com\n export DOKKU_APP=my-app-name\n\nSetting these variables in your virtualenv's `postactivate` hook may \nbe useful.\n\nUsage\n-----\n\nOnce installed, usage is simple:\n\n.. code-block:: bash\n\n dokku-client help\n\nProduces:\n\n.. code-block:: none\n\n Client for Dokku\n\n usage:\n dokku-client [...]\n dokku-client help\n\n global options:\n -H , --host= Host address\n -a , --app= App name\n\n full list of available commands:\n\n help Show this help message\n configget Set one or more config options\n configset Set one or more config options in the app's ENV file\n prompt Open a prompt\n restart Restart the container\n\n See 'git help ' for more information on a specific command.\n\nContributing new commands\n-------------------------\n\nDokku-client allows any developer to hook in extra commands. This is done using \nexactly the same mechanism that dokku-client uses internally, that of entry points\nprovided by ``setuptools``.\n\nFirst, create a python package. You may have your own favorite way of doing this, but I \nuse seed_:\n\n.. code-block:: bash\n \n mkdir dokku-client-mycommand\n cd dokku-client-mycommand\n pip install seed\n seed create\n ls\n\nSecond, create a class which extends ``dokku_client.BaseCommand`` and implements the method\n``main(args)``. Also, the doc-block at the top \nof the class will be used by docopt_ to parse any command line arguments, so make \nsure you include that. See the `prompt command`_ for an example.\n\nAnd third, in your new ``setup.py`` file, specify your new class as an entry point:\n\n.. code-block:: python\n\n entry_points={\n 'dokku_client.commands': [\n 'mycommand = dokku_client_mycommand.mycommand:MyCommand',\n ],\n }\n\nRun ``setup.py`` so that the new entry point is initialized:\n\n.. code-block:: bash\n \n # Run in develop mode, so files will not be copied away.\n # You can continue to edit your code as usual\n python setup.py develop\n\nYou should now find that your new command is available in dokku-client, \nrun ``dokku-client help`` to check.\n\nOnce done, you can release your package to PyPi using ``seed release --initial``.\n\n.. _Dokku: https://github.com/progrium/dokku\n.. _docopt: http://docopt.org/\n.. _prompt command: https://github.com/adamcharnock/dokku-client/blob/master/dokku_client/commands/prompt.py\n.. _seed: https://github.com/adamcharnock/seed", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/adamcharnock/dokku-client", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "dokku-client", "package_url": "https://pypi.org/project/dokku-client/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/dokku-client/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/adamcharnock/dokku-client" }, "release_url": "https://pypi.org/project/dokku-client/0.2.3/", "requires_dist": null, "requires_python": null, "summary": "Heroku-style command line interface for Dokku", "version": "0.2.3" }, "last_serial": 1099770, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "7ed7d5c3159bda40ba0fa063d2da18a1", "sha256": "b4d52b573e26c44e6bde3968b1c2069f366ef04304697ed2a7d66a342aa30640" }, "downloads": -1, "filename": "dokku-client-0.1.0.tar.gz", "has_sig": false, "md5_digest": "7ed7d5c3159bda40ba0fa063d2da18a1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4130, "upload_time": "2013-08-04T18:12:51", "url": "https://files.pythonhosted.org/packages/e5/c7/35b196af24e6dfa4dc372b9f3da183bfe1acbbaaf6558c3dbb2338f80c1a/dokku-client-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "1a242c338dddaefd09433013c0e64504", "sha256": "ff84e8340982e46d661f5efc31106826b9d2a3e1e3d22b06f019f65a84890d40" }, "downloads": -1, "filename": "dokku-client-0.2.0.tar.gz", "has_sig": false, "md5_digest": "1a242c338dddaefd09433013c0e64504", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6378, "upload_time": "2013-08-04T23:01:12", "url": "https://files.pythonhosted.org/packages/1b/ef/e04fe6f5bb92df8054fd06dfa61d63177402425e3e374974fa187e202586/dokku-client-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "6b1f8150bd24a2ddc322f10736c60068", "sha256": "15a0b2a5f16ef06c11be8777c098fb2eb640a3ecd20d8df36981bc2d1be3046c" }, "downloads": -1, "filename": "dokku-client-0.2.1.tar.gz", "has_sig": false, "md5_digest": "6b1f8150bd24a2ddc322f10736c60068", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6462, "upload_time": "2013-08-04T23:07:41", "url": "https://files.pythonhosted.org/packages/68/f8/c3bcc132824e1994c57e2a0778ba26f7c10136fc69139238606da351eacc/dokku-client-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "a5676e99d05c4c5241d09806da741f49", "sha256": "264ae5d9aa4575409a5af38a419ea6c843bfce644019e43ef9305c4401803672" }, "downloads": -1, "filename": "dokku-client-0.2.2.tar.gz", "has_sig": false, "md5_digest": "a5676e99d05c4c5241d09806da741f49", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6556, "upload_time": "2013-08-04T23:17:46", "url": "https://files.pythonhosted.org/packages/28/1b/a24487236879a58c3c8a5af476a09f660e4ad345922459f9c89e0a2081a5/dokku-client-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "d534e8020dac96dafc49d4a81643eb5e", "sha256": "f3456c5329fa54dcb294d117f50b3a7ae8d1a8ecaa228a4178c18c3ad98c197e" }, "downloads": -1, "filename": "dokku-client-0.2.3.tar.gz", "has_sig": false, "md5_digest": "d534e8020dac96dafc49d4a81643eb5e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6749, "upload_time": "2014-05-21T14:02:12", "url": "https://files.pythonhosted.org/packages/d2/12/fde068e572e8ca1beef8add599af53c1cc2c6bc470ad1dcc7455ef90429c/dokku-client-0.2.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d534e8020dac96dafc49d4a81643eb5e", "sha256": "f3456c5329fa54dcb294d117f50b3a7ae8d1a8ecaa228a4178c18c3ad98c197e" }, "downloads": -1, "filename": "dokku-client-0.2.3.tar.gz", "has_sig": false, "md5_digest": "d534e8020dac96dafc49d4a81643eb5e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6749, "upload_time": "2014-05-21T14:02:12", "url": "https://files.pythonhosted.org/packages/d2/12/fde068e572e8ca1beef8add599af53c1cc2c6bc470ad1dcc7455ef90429c/dokku-client-0.2.3.tar.gz" } ] }