{ "info": { "author": "Timo Furrer", "author_email": "tuxtimo@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Utilities" ], "description": "minion-ci\n=========\n|pypi| |license|\n\n**minion-ci** is a minimalist, decentralized, flexible Continuous Integration Server for hackers.\n\n|screenshot_index|\n\n\n.. contents::\n :local:\n :depth: 2\n :backlinks: none\n\nQuickstart\n----------\n\nMaking your repository *minion compatible* is as easy as running this command in the root of your repository:\n\n.. code::\n\n minion init\n\nAfter that you should modify the ``minion.yml`` file in your repository to fit your needs. Make a nice commit and run the following command to start your first job:\n\n.. code::\n\n git minion\n \nIf the *minion server* successfully started you can browse the web interface at http://localhost:5000\n\nInstallation\n------------\n\nIt's recommended to use pip to install minion-ci:\n\n.. code::\n\n pip3 install minion-ci\n\n\n**MongoDB:**\nTo persist the job data *minion-ci* uses MongoDB.\nMake sure you have MongoDB installed ...\n\n.. code::\n\n apt-get install mongodb\n yum install mongodb\n\n... and an instance is running:\n\n.. code::\n\n ps -ef | grep mongod\n\n... eventually start one with:\n\n.. code::\n\n mongod\n\nminion.yml File Format\n----------------------\n\nThe **minion-ci** server will clone your repository and parse a file called **minion.yml** located\nin the root of the cloned repository. The format is really simple:\n\n.. code:: yaml\n\n # command which is run before the real command\n precondition: \"echo 'I was run before the test ...'\"\n # the test command\n command: \"echo 'This is my test...'\"\n on:\n # command which is run if the command was successful\n success: \"echo 'I was run because the test was successful ...'\"\n # command which is run if the command failed\n failure: \"echo 'I was run because the test failed ...'\"\n\nminion.yml Receipts\n-------------------\n\nThe following few sections explain how to setup a ``minion.yml`` file for different\nkind of environments and technologies, like python virtualenvs, docker containers, etc.\n\n**Why so complicated?** ... Well it's not really complicated, isn't it? There are just to many\ndifferent styles of test environments and approaches ... I don't want to give full attention to all\nof them and support them.\nAnd anyway ... In the end your Use-Case wouldn't be supported. Thus, we provide each developer the full\ncontrol over their own test setup and environment. Setup it up how you like and run your test how you like it.\n**But**: Here are some receipts which might help you to come up with a nice minion.yml configuration:\n\nPython virtualenv\n~~~~~~~~~~~~~~~~~\n\nTo test your code in a python virtualenv base your minion.yml on the following example:\n\n.. code:: yaml\n\n precondition: >\n /bin/bash -c 'virtualenv env -p python3.4 &&\n source env/bin/activate && python -m pip install . -r requirements-dev.txt'\n command: /bin/bash -c 'source env/bin/activate && make test'\n\nMake sure you change the actual *test* command which in the example's case is ``make test``.\nYou can also easily integrate it with ``tox``. Just make sure ``tox`` is installed and run as your\ntest command.\n\nDocker\n~~~~~~\n\nTo test your code in a docker container follow the following example to setup your minion.yml:\n\n.. code:: yaml\n\n precondition: /bin/bash -c 'docker pull ubuntu'\n command: /bin/bash -c 'docker run -t ubuntu /bin/bash -c \"make test\"'\n\nThis will pull a new ubuntu docker image from docker hub and run ``make test`` in the container.\nYou might want to setup your own docker image in the ``precondition`` and the run this container\nin the actual ``command``:\n\n.. code:: yaml\n\n precondition: /bin/bash -c 'docker build -t testing .'\n command: /bin/bash -c 'docker run -t testing /bin/bash -c \"make test\"'\n\nMake sure you mount your repository, source code, test code or whatever in the container before running\nany tests.\n\nServer API\n----------\n\n+----------------+-------------+-----------------+--------------------------+\n| Route | HTTP Method | Parameter | Description |\n+================+=============+=================+==========================+\n| /status | GET | | Get status of the server |\n+----------------+-------------+-----------------+--------------------------+\n| /jobs | GET | page, | Get a list of all jobs |\n| | | page_size | |\n+----------------+-------------+-----------------+--------------------------+\n| /jobs | POST | repo_url, | Create a new job |\n| | | commit_hash, | |\n| | | branch, | |\n| | | keep_data, | |\n| | | arbitrary data | |\n+----------------+-------------+-----------------+--------------------------+\n| /jobs | DELETE | | Remove all jobs |\n+----------------+-------------+-----------------+--------------------------+\n| /jobs/ | GET | | Get a single job |\n+----------------+-------------+-----------------+--------------------------+\n| /jobs/ | DELETE | | Remove a single job |\n+----------------+-------------+-----------------+--------------------------+\n| /stop | POST | | Stop the minion-server |\n+----------------+-------------+-----------------+--------------------------+\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/minion-ci.svg?style=flat&label=version\n :target: https://pypi.python.org/pypi/minion-ci\n :alt: Latest version released on PyPi\n\n.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat\n :target: https://raw.githubusercontent.com/timofurrer/minion-ci/master/LICENSE\n :alt: Package license\n\n.. |screenshot_index| image:: https://raw.githubusercontent.com/timofurrer/minion-ci/master/screenshots/index_0.0.6.jpg\n :alt: Index Page\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/timofurrer/minion-ci", "keywords": "minion-ci", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "minion-ci", "package_url": "https://pypi.org/project/minion-ci/", "platform": "", "project_url": "https://pypi.org/project/minion-ci/", "project_urls": { "Homepage": "https://github.com/timofurrer/minion-ci" }, "release_url": "https://pypi.org/project/minion-ci/0.0.7/", "requires_dist": null, "requires_python": "", "summary": "minimalist, decentralized, flexible Continuous Integration Server for hackers", "version": "0.0.7" }, "last_serial": 2820006, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "6ff56e735a6ec70550a2a2a3ef6530df", "sha256": "7da730468f8302e1ba4de3009a95e65c722f45a71775a9bddbe46f1d2769eec6" }, "downloads": -1, "filename": "minion-ci-0.0.1.tar.gz", "has_sig": false, "md5_digest": "6ff56e735a6ec70550a2a2a3ef6530df", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7677, "upload_time": "2016-03-07T06:51:43", "url": "https://files.pythonhosted.org/packages/ed/0f/2eec96f9349dc4ed87d66b69185154b974d3e41bf08ddd89fc752d9bef23/minion-ci-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "bdaff3b658f52ed65c650178365012ce", "sha256": "cd939ed840623c7358392c0a6df9b3722d7ca85bcf7221ca325ac7c5c300bf29" }, "downloads": -1, "filename": "minion-ci-0.0.2.tar.gz", "has_sig": false, "md5_digest": "bdaff3b658f52ed65c650178365012ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9781, "upload_time": "2016-03-08T07:02:42", "url": "https://files.pythonhosted.org/packages/89/27/3d7927575e173b78c5e7db0700960468f31688e22deb4bedcd677e4bc33b/minion-ci-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "cd1dad412354c3fb9c2e7cb6e9aa2093", "sha256": "85830bc126339845254c20b71c9749009f7415581265d4067a05a15b72c4b714" }, "downloads": -1, "filename": "minion-ci-0.0.3.tar.gz", "has_sig": false, "md5_digest": "cd1dad412354c3fb9c2e7cb6e9aa2093", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9819, "upload_time": "2016-03-08T07:11:23", "url": "https://files.pythonhosted.org/packages/ab/0c/d1857b59b8bd62d84b45b3c6f8f727b8947986bf1999d57b8bd13b5179eb/minion-ci-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "f4b2185ad5682647ea1f5234ca45c096", "sha256": "3b3f7bc512102f2694a95c7f1a70d976bcd6af76ec1afd08c4eaad11a0e6a067" }, "downloads": -1, "filename": "minion-ci-0.0.4.tar.gz", "has_sig": false, "md5_digest": "f4b2185ad5682647ea1f5234ca45c096", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39830, "upload_time": "2016-03-08T07:13:41", "url": "https://files.pythonhosted.org/packages/af/f8/550a5b325744b9463f34e940ae5f978dd1f2d67a1ba5ed3311617d49d45b/minion-ci-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "b056c12f94cf72764f11bdfd3e4e6185", "sha256": "35ac002ceb9cf73d99ee4ca08cb9c40fdeaf7692b49becb599fbd2e8655d9f4c" }, "downloads": -1, "filename": "minion-ci-0.0.5.tar.gz", "has_sig": false, "md5_digest": "b056c12f94cf72764f11bdfd3e4e6185", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41168, "upload_time": "2016-03-12T23:03:50", "url": "https://files.pythonhosted.org/packages/e1/e1/d228aef9dd1016f40d9c903d59cfc1200a95938bb9c7d0d03ff2ccf58448/minion-ci-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "dbfcbf297dd7d99ce0a489a2657e5376", "sha256": "448cce18d8fe461befca735ec7ab6da6e924d31124d4272e13cc330e23b0a21e" }, "downloads": -1, "filename": "minion-ci-0.0.6.tar.gz", "has_sig": false, "md5_digest": "dbfcbf297dd7d99ce0a489a2657e5376", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41300, "upload_time": "2016-03-15T05:23:33", "url": "https://files.pythonhosted.org/packages/c5/a7/b35543f767094d7ad449d0de45f9077118351abd31c2e356c566c7787dbc/minion-ci-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "ca4c51169d3fdcb5bca3ceab52788770", "sha256": "c45445bdd2d616d5345f0146227334657ee18109a23f4103dd5805519982a037" }, "downloads": -1, "filename": "minion-ci-0.0.7.tar.gz", "has_sig": false, "md5_digest": "ca4c51169d3fdcb5bca3ceab52788770", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41822, "upload_time": "2017-04-21T17:32:12", "url": "https://files.pythonhosted.org/packages/a3/d6/43147e44ae29b2bdf06bb9fd052ee923269b965935c1c090a70e4892053f/minion-ci-0.0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ca4c51169d3fdcb5bca3ceab52788770", "sha256": "c45445bdd2d616d5345f0146227334657ee18109a23f4103dd5805519982a037" }, "downloads": -1, "filename": "minion-ci-0.0.7.tar.gz", "has_sig": false, "md5_digest": "ca4c51169d3fdcb5bca3ceab52788770", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41822, "upload_time": "2017-04-21T17:32:12", "url": "https://files.pythonhosted.org/packages/a3/d6/43147e44ae29b2bdf06bb9fd052ee923269b965935c1c090a70e4892053f/minion-ci-0.0.7.tar.gz" } ] }