{ "info": { "author": "Snaipe", "author_email": "franklinmathieu@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: POSIX", "Programming Language :: Python :: 3.4", "Topic :: System :: Systems Administration", "Topic :: Utilities" ], "description": "|Tequila|\n=========\n\n|Downloads| |Python versions| |License| |Format|\n\nTequila is a command-line Minecraft server manager written in python.\n\nIt does not aim to be a server wrapper, though it provides a simple one\nusing GNU screen.\n\nIt provides some basic functions to create, deploy, and manage multiple\nservers on the same host.\n\nFeatures\n--------\n\n- Plugins and server jars are pulled from maven repositories, and are\n managed as maven dependencies.\n- Everything is command-line (no GUI) and can be done over SSH.\n- Every server is highly configurable and automated.\n- Compatible with all kinds of servers (Bukkit, Vanilla, Spigot, ...)\n\nInstallation\n------------\n\nPrerequisites\n~~~~~~~~~~~~~\n\n- `python 3 `__\n- `GNU Screen `__ (Optional if\n using a custom server wrapper)\n- `Maven 3 `__\n\nWith the package manager (recommended)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nFrom an elevated shell, run ``pip install tequila``.\n\nFrom the source code\n~~~~~~~~~~~~~~~~~~~~\n\nFrom an elevated shell, run\n``pip install -e git+https://github.com/Snaipe/Tequila.git egg=tequila``.\n\nYou may check if Tequila is installed by running ``tequila -h``\n\nGetting started\n---------------\n\nMake sure you have properly installed Tequila and all of its\ndependencies.\n\n1. **Configure Tequila's home directory**\n The first thing you might want to change is the directory where\n Tequila will manage the servers. Tequila will try to read the value\n of the ``TEQUILA_HOME`` environment variable, and fallback to the\n value of default\\_home specified inside ``/etc/tequila/tequila.conf``\n if the variable is not defined -- this is why you might want to\n either set the variable in your shell startup file or in\n ``/etc/environment``, or change the value of default\\_home.\n\n2. **Create a server**\n To create a server, simply enter ``tequila init [server name]``, then\n navigate to the newly created server directory. There, you will find\n 3 files:\n\n - ``application.opts``: the executable jar parameters\n - ``jvm.opts``: the Java Virtual Machine parameters\n - ``tequila.config``: the server configuration\n\n The ``application.opts`` and ``jvm.opts`` can be tuned to fit your\n specifications. ``tequila.config`` is the configuration file where\n you will put the repositories, plugins, and server artifacts to use\n during production.\n\n3. **Deploy the server**\n Once done, deploy your server using\n ``tequila deploy [server name]``. This will try to resolve, download,\n and copy all of the artifacts needed for your server.\n\n4. **Start the server**\n At that point, you are (almost) done. You may start your server\n with ``tequila start [server name]``, and configure your plugins.\n\nThis covers the basic use of Tequila.\n\nFor more information on all the available commands, run ``tequila -h``,\nand ``tequila [command] -h``.\n\nPulling plugins from http://dev.bukkit.org/\n-------------------------------------------\n\nTequila only pulls plugins from maven repositories, but since most (if\nnot all) plugins come from\n`BukkitDev `__, we made a nice\ntool called `BlackDog `__.\n\nBlackDog, more than being a nice cocktail made with tequila, is a web\nservice that maps plugins from BukkitDev to a maven repository\nstructure.\n\nYou can set it up somewhere and run it (be it locally or remotely), then\nadd the proper repository inside the configuration file of your\nserver(s):\n\n::\n\n ```\n [repositories]\n ...\n blackdog: http://example.com:port/\n ```\n\n... and then reference your plugins as normal maven artifacts:\n\n::\n\n ```\n [plugins]\n ...\n plugin-a: local.blackdog:plugin-a:1.0.1\n plugin-b: local.blackdog:plugin-b:2.3.6\n ...\n ```\n\nYou might notice that in this example, the group ids are set to\n``local.blackdog`` -- this is a consequence of BlackDog being 'group-id\nagnostic': since BukkitDev does not have any group id information, you\ncan pretty much set the group id to the value you want, and BlackDog\nwill respond accordingly.\n\nThere are no limitations on the group id you specify, but we advise you\nto use something unique such as ``local.blackdog`` to prevent the plugin\nfrom being pulled from something *other* than BukkitDev.\n\nAs a side note, all artifacts visible on the web service are *releases*\nand must be considered as such when entering the plugin version (i.e.\ndon't put '-SNAPSHOT' at the end of the plugin version if you pull the\nplugin from BlackDog).\n\nFAQ\n---\n\n**Q: How can I access my server's console ?**\nA: If you left the ``wrapper-type`` option to 'screen', then Tequila\nwill use `Screen `__ to manage the\nserver, so for the moment you only need to attach to the associated\nscreen. This may be done with the command ``screen -r tequila_``,\nwhere ```` is your server's name.\nOtherwise, attach to your console using the method provided by your\nwrapper.\n\n**Q: Help, I attached to the console, but I can't get out !**\nA: You need to detach from the screen by pressing \"Ctrl-a, d\".\n\n**Q: I changed some settings in tequila.config, how do I update the\nserver again ?**\nA: First, make sure your server is stopped, then run again\n``tequila deploy ``.\n\n**Q: How do I get ?**\nA: See answer below.\n\n**Q: Most plugins are not on maven repositories, how do I get Tequila\nto download those ?**\nA: Consider using `Blackdog `__\nwith tequila, or manually download all the needed non-maven dependencies\nwith ``tequila download [url]``. You could also set-up your own maven\nrepository and put all the needed plugins in there.\n\n**Q: Why is Tequila missing ?**\nA: We gladly take suggestions on the `issue management\nsystem `__, if you'd like to\nsee a new feature on Tequila and you're a developer, feel free to fork\nthis repository and submit a pull request -- see section\nContributing to know how to get yours accepted.\n\n**Q: I have an issue / bug, what do I do ?**\nA: Go to the `issue management\nsystem `__, then search if the\nproblem has already been documented. If not, feel free to open a new\nticket.\n\nContributing\n------------\n\nYou need to observe the following rules for pull requests:\n\n- Your modifications must be working and tested.\n- Follow python's official formatting rules and be consistent with the\n project style.\n- Squash your commits into one if you can.\n- If new files are added, please say so in the commit message, and add\n the license header.\n- Keep your commit messages simple and concise. Good commit messages\n start with a verb ('Add', 'Fix', ...).\n- Your branch must be based off an up-to-date master, or at least must\n be able to be merged automatically.\n- Sign off your pull request message by appending 'Signed-off-by:\n ' to the message.\n\nBy submitting a pull request you accept to license your code under the\nGNU Public License version 3.\n\nDonating\n--------\n\nIf you like Tequila, consider `buying me a\nbeer `__\n!\n\n.. |Tequila| image:: https://github.com/Snaipe/Tequila/blob/graphics/logo.png?raw=true\n.. |Downloads| image:: https://pypip.in/d/tequila/badge.svg\n :target: https://pypi.python.org/pypi/tequila/\n.. |Python versions| image:: https://pypip.in/py_versions/tequila/badge.svg\n :target: https://pypi.python.org/pypi/tequila/\n.. |License| image:: https://pypip.in/license/tequila/badge.svg\n :target: https://github.com/Snaipe/Tequila/blob/master/LICENSE\n.. |Format| image:: https://pypip.in/format/tequila/badge.svg\n :target: https://pypi.python.org/pypi/tequila/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/Snaipe/tequila", "keywords": "minecraft server manager", "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "tequila", "package_url": "https://pypi.org/project/tequila/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/tequila/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/Snaipe/tequila" }, "release_url": "https://pypi.org/project/tequila/1.1.1/", "requires_dist": null, "requires_python": null, "summary": "A minecraft server manager", "version": "1.1.1" }, "last_serial": 1199844, "releases": { "1.0.4": [ { "comment_text": "built for Linux-3.15.1-1-ARCH-x86_64-with-glibc2.3.4", "digests": { "md5": "71933b4ef0096dd99c1f1cb6ebb8d92d", "sha256": "f41e47f68dcb5e5e2ecdd310bd37f788f8326a19e9c79881e14c24feceb5113a" }, "downloads": -1, "filename": "tequila-1.0.4.linux-x86_64.tar.gz", "has_sig": false, "md5_digest": "71933b4ef0096dd99c1f1cb6ebb8d92d", "packagetype": "bdist_dumb", "python_version": "any", "requires_python": null, "size": 26281, "upload_time": "2014-07-30T20:33:27", "url": "https://files.pythonhosted.org/packages/fd/67/7f30a45a93a5e79c1103a2f5b76c984f9abcfa550035f2dcb5ed487765e5/tequila-1.0.4.linux-x86_64.tar.gz" }, { "comment_text": "", "digests": { "md5": "c4df755f5c1ddfa09288c494f44328c1", "sha256": "317abbb24b6af90431e8ab11016754fa22e75f12d00b7e2c8d2e41d31ca50a20" }, "downloads": -1, "filename": "tequila-1.0.4-py3.4.egg", "has_sig": false, "md5_digest": "c4df755f5c1ddfa09288c494f44328c1", "packagetype": "bdist_egg", "python_version": "3.4", "requires_python": null, "size": 41604, "upload_time": "2014-07-30T20:33:33", "url": "https://files.pythonhosted.org/packages/33/3f/39b929f2c395d2764692eb5aa5be53352c9cc4f7620d660d34e303582420/tequila-1.0.4-py3.4.egg" }, { "comment_text": "", "digests": { "md5": "cf5459441697c07c44eb1a7517e8dc11", "sha256": "f0bf63d9dd9f945c18b7c8482bfdcb33fb4f02741a6bb05ff73086c59fd43bb9" }, "downloads": -1, "filename": "tequila-1.0.4.tar.gz", "has_sig": false, "md5_digest": "cf5459441697c07c44eb1a7517e8dc11", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28034, "upload_time": "2014-07-30T20:33:29", "url": "https://files.pythonhosted.org/packages/13/54/ef25c0bb23017aea50bab71310e2474da74bb3fc73022b7ce2c02b884b90/tequila-1.0.4.tar.gz" } ], "1.1.0": [ { "comment_text": "built for Linux-3.15.7-1-aufs_friendly-x86_64-with-glibc2.3.4", "digests": { "md5": "02a9ce39915d065b6ebb24b4d529265d", "sha256": "23b6c1b5a17365267f61cf9682ef1fb1701c5c28c53bc519d9ebd73a25dc437a" }, "downloads": -1, "filename": "tequila-1.1.0.linux-x86_64.tar.gz", "has_sig": false, "md5_digest": "02a9ce39915d065b6ebb24b4d529265d", "packagetype": "bdist_dumb", "python_version": "any", "requires_python": null, "size": 50624, "upload_time": "2014-08-23T13:49:10", "url": "https://files.pythonhosted.org/packages/66/67/478c6d63d1f7d94e09acda4b46f719820d89a2bf609b061cc844459008d8/tequila-1.1.0.linux-x86_64.tar.gz" }, { "comment_text": "", "digests": { "md5": "a4d796d4c083246314eac630432e555e", "sha256": "686bc654720697507d95fbc87863dbe5909cdffe94934712234cac6a98761107" }, "downloads": -1, "filename": "tequila-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "a4d796d4c083246314eac630432e555e", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 38968, "upload_time": "2014-08-23T16:57:04", "url": "https://files.pythonhosted.org/packages/9c/4d/fd0bc5f594e1a29bba8ad3e23e27e7dde707df16835d3b7d19ee673a5e29/tequila-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86abb25ba9baf20d4e78e1e61fe5f552", "sha256": "c81fc9abde21f8d5f175f6f953ca2d060fc6b14718340cdc2a6bb820d78012f0" }, "downloads": -1, "filename": "tequila-1.1.0.tar.gz", "has_sig": false, "md5_digest": "86abb25ba9baf20d4e78e1e61fe5f552", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33779, "upload_time": "2014-08-23T13:49:07", "url": "https://files.pythonhosted.org/packages/90/6e/c60cb50c82eb9cf36215fa7dbaeb435c2c2dc4bc02a33d2fe742cfe8ebbe/tequila-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "e227037075e9bfd6387a9d172657dcbb", "sha256": "975dd4a3d26655f0427a91f0c0a4272fba66539e0b4125f9ee478bd3ea64fe32" }, "downloads": -1, "filename": "tequila-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "e227037075e9bfd6387a9d172657dcbb", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 45421, "upload_time": "2014-08-23T19:22:59", "url": "https://files.pythonhosted.org/packages/ea/e8/fc5fdb35399e5d31236c84c03e055956e296bb19831850dfe22c4def4ad9/tequila-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "07c50cb11f17cf455136dff55770437f", "sha256": "1b4daeca01ff2eda7f65c984537ccb763f232c7dea1587da290a4180e3641903" }, "downloads": -1, "filename": "tequila-1.1.1.tar.gz", "has_sig": false, "md5_digest": "07c50cb11f17cf455136dff55770437f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41917, "upload_time": "2014-08-23T19:22:57", "url": "https://files.pythonhosted.org/packages/49/c1/7dfe8b301e8886e00e605b26ecb219169ae4aa8c6c3ee3a3162e9dd391f9/tequila-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e227037075e9bfd6387a9d172657dcbb", "sha256": "975dd4a3d26655f0427a91f0c0a4272fba66539e0b4125f9ee478bd3ea64fe32" }, "downloads": -1, "filename": "tequila-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "e227037075e9bfd6387a9d172657dcbb", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 45421, "upload_time": "2014-08-23T19:22:59", "url": "https://files.pythonhosted.org/packages/ea/e8/fc5fdb35399e5d31236c84c03e055956e296bb19831850dfe22c4def4ad9/tequila-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "07c50cb11f17cf455136dff55770437f", "sha256": "1b4daeca01ff2eda7f65c984537ccb763f232c7dea1587da290a4180e3641903" }, "downloads": -1, "filename": "tequila-1.1.1.tar.gz", "has_sig": false, "md5_digest": "07c50cb11f17cf455136dff55770437f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41917, "upload_time": "2014-08-23T19:22:57", "url": "https://files.pythonhosted.org/packages/49/c1/7dfe8b301e8886e00e605b26ecb219169ae4aa8c6c3ee3a3162e9dd391f9/tequila-1.1.1.tar.gz" } ] }