{ "info": { "author": "Brad Brown", "author_email": "brad@bradsbrown.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "JGT Tools\n=========\n\nJGT Tools is a collection of package helpers\nfor common CLI functions\nwithin a properly-formatted repository.\n\n\nQuickstart\n----------\n\nJust include ``jgt_tools`` in your package VirtualEnv,\nand you'll have access to these CLI calls:\n\n- ``env-setup`` - set up the development environment\n with all packages and pre-commit checks\n- ``self-check`` - run self-checks/linters/etc. on your repository\n- ``run-tests`` - run your in-repo test suite\n- ``build-docs`` - build repo documentation locally\n- ``build-and-push-docs`` - both build the docs,\n then publish to your gh-pages branch\n- ``check-version`` - raise an error if package-relevant files have changed\n without a version bump\n\nDetails for each script can be found by calling with the ``--help`` flag.\n\n\nDocumentation Index\n-------------------\n\nIn order to get the full benefit from ``build-docs``,\nit is encouraged to create an index file\nthat pulls together all the documentation.\nThis file needs to be in the root folder\nand should be called ``.jgt_tools.index``.\nThis will be moved into the working directory for Sphinx\nand be used when building the documentation.\nAdditional information can be found on the `Sphinx site`_.\n\nConfiguration\n-------------\n\nA number of the actions to be called\ncan be customized in a ``[tool.jgt_tools]``\nin your ``pyproject.toml`` file.\nAvailable values are:\n\n- ``env_setup_commands`` - a list of commands to be run\n under the ``env-setup`` call\n- ``self_check_commands`` - a list of commands to be run\n under the ``self-check`` call\n- ``run_tests_commands`` - a list of commands to be run\n under the ``run-tests`` call\n- ``doc_build_types`` - a list of types for doc construction:\n - ``api`` is currently the only supported option\n\nFor example::\n\n [tool.jgt_tools]\n env_setup_commands = [\n \"poetry install\",\n \"poetry run pip install other_package\",\n \"./my_custom_setup_script.sh\"\n ]\n doc_build_types = []\n\nwould run your specified commands for ``env-setup``\nand skip the ``api`` doc builder.\n\nIn addition,\nthe function to verify which files are relevant to ``check-version``\ncan be customized.\nBy default, if any files in the diff against master are ``.py`` files,\na version bump is expected,\nbut the user can provide an alternate function to verify filenames.\n\nThe function should expect a list of strings\nrepresenting file paths relative from project root\n(as provided by ``git diff master --name-only``)\nand return a boolean representing if a version change should be ensured\n(i.e. ``True`` if version should be checked).\n\nThis can be registered as a plugin in your ``pyproject.toml`` file::\n\n [tools.poetry.plugins.\"file_checkers\"]\n \"version_trigger\" = \"my_module:my_function\"\n\nor in your ``setup.py`` file::\n\n setup(\n ...\n entry_points={\n \"version_trigger\": [\"version_trigger = my_module:my_fuction\"]\n }\n )\n\n.. _`Sphinx site`: http://www.sphinx-doc.org/en/master/usage/quickstart.html#defining-document-structure\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://jolly-good-toolbelt.github.io/jgt_tools/", "keywords": "", "license": "MIT", "maintainer": "Brad Brown", "maintainer_email": "brad@bradsbrown.com", "name": "jgt-tools", "package_url": "https://pypi.org/project/jgt-tools/", "platform": "", "project_url": "https://pypi.org/project/jgt-tools/", "project_urls": { "Documentation": "https://jolly-good-toolbelt.github.io/jgt_tools/", "Homepage": "https://jolly-good-toolbelt.github.io/jgt_tools/", "Repository": "https://github.com/jolly-good-toolbelt/jgt_tools" }, "release_url": "https://pypi.org/project/jgt-tools/0.2.3/", "requires_dist": [ "tomlkit (>=0.5.3,<0.6.0)", "sphinx (>=2.1,<3.0); extra == \"build_docs\"", "sphinx-rtd-theme (>=0.4.3,<0.5.0); extra == \"build_docs\"", "ghp-import (>=0.5.5,<0.6.0); extra == \"build_docs\"" ], "requires_python": ">=3.6,<4.0", "summary": "A collection of tools for commmon package scripts", "version": "0.2.3" }, "last_serial": 5574608, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d472b2fc75e10bb0a0202802ad5fa1df", "sha256": "7862a304144a46cb3f1ba42af6d738750386d3a882dc49850ed9370b75e476cd" }, "downloads": -1, "filename": "jgt_tools-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d472b2fc75e10bb0a0202802ad5fa1df", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 5950, "upload_time": "2019-07-08T13:24:26", "url": "https://files.pythonhosted.org/packages/f8/2e/659e3561242ea4c5141bbfcf09b8c2c1d1722ba8d6a638ec9a7825faddf4/jgt_tools-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bf76b06aea7ae031c64ef3981fbe7146", "sha256": "da2a89569062f19620281d5238932374ce4240ce60c43b6a24dba7cb429a2d0e" }, "downloads": -1, "filename": "jgt_tools-0.1.0.tar.gz", "has_sig": false, "md5_digest": "bf76b06aea7ae031c64ef3981fbe7146", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 3929, "upload_time": "2019-07-08T13:24:28", "url": "https://files.pythonhosted.org/packages/5f/62/2bfccb42bdddb28953969f241c2b853cbc0c231fbad76f9ce0f59ffdadf5/jgt_tools-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "d2c6481dc3b72bc96ffa7c4e81b3ae1a", "sha256": "99252c559e151981ed22a1a4d58dae28ee88b71070f8fe05d8df778b1e098dcc" }, "downloads": -1, "filename": "jgt_tools-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d2c6481dc3b72bc96ffa7c4e81b3ae1a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 6031, "upload_time": "2019-07-08T14:18:49", "url": "https://files.pythonhosted.org/packages/61/55/5186a628acf6a2e3e9bc50854dba470351f25231560e6dde986adf39d377/jgt_tools-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73fe601b73e9dbf6512e5ef0c8227f89", "sha256": "6ddc4323691946ab35ebc3f4db354367277340f0633a5ff3725565f708306706" }, "downloads": -1, "filename": "jgt_tools-0.1.1.tar.gz", "has_sig": false, "md5_digest": "73fe601b73e9dbf6512e5ef0c8227f89", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 4047, "upload_time": "2019-07-08T14:18:50", "url": "https://files.pythonhosted.org/packages/0a/63/98a263bc958491ad5cb9c9d0b7648a7a5a74aa0d1f7ddf49ba95c849fe10/jgt_tools-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "63abd588aac1ac046721ea2ca70d4757", "sha256": "4c8ce4825977f0421aa6b6a5a96cf1924e89152214bc4e3887d6e4779073f985" }, "downloads": -1, "filename": "jgt_tools-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "63abd588aac1ac046721ea2ca70d4757", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 7036, "upload_time": "2019-07-17T17:01:37", "url": "https://files.pythonhosted.org/packages/19/08/7cadec327db04a29394a91adc6f507ffa1ff8ee92f61bf6e5803a2125e66/jgt_tools-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "21861356ddce1d2a26b88beabdbcc22f", "sha256": "e80fcff1dcc06789975de39c7887c729bdffe400ad87ccba95e7dcfbe2cfb99a" }, "downloads": -1, "filename": "jgt_tools-0.1.2.tar.gz", "has_sig": false, "md5_digest": "21861356ddce1d2a26b88beabdbcc22f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 4933, "upload_time": "2019-07-17T17:01:39", "url": "https://files.pythonhosted.org/packages/93/c1/20a2398f3abd877a5045e6e77ae5f4f89b1316d5e3029e4fc8974fc75c4d/jgt_tools-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "7d7e4f9df1abf437fce9e640205894ed", "sha256": "b696b52ecd3e4bc87153ed99ad5726eaccb2900d3bf479e897dfc12b41c0f645" }, "downloads": -1, "filename": "jgt_tools-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "7d7e4f9df1abf437fce9e640205894ed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 7034, "upload_time": "2019-07-17T23:23:07", "url": "https://files.pythonhosted.org/packages/f9/63/17976d5b9d7bd12d736fc78aa5d7469bafc6b32e307331b2bab40594c7fc/jgt_tools-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "eb619639ed8810b6edc652491a87f2ec", "sha256": "78a04ad08de9611ab6d6c0120e8e7a681f514384207d9b040aa68787afa6dc4b" }, "downloads": -1, "filename": "jgt_tools-0.1.3.tar.gz", "has_sig": false, "md5_digest": "eb619639ed8810b6edc652491a87f2ec", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 4936, "upload_time": "2019-07-17T23:23:09", "url": "https://files.pythonhosted.org/packages/8d/68/c882197afcd2a52397bf4ff0ffdbf9eb17691aa40c7b39c0d618094742e8/jgt_tools-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "da149f0be769f6ce8d4d0c9c3096a33f", "sha256": "342992688da8747defa5247952ad84686ef0f7958c1d074bb084c8e7d940bbb7" }, "downloads": -1, "filename": "jgt_tools-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "da149f0be769f6ce8d4d0c9c3096a33f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 8115, "upload_time": "2019-07-19T21:12:28", "url": "https://files.pythonhosted.org/packages/24/85/20cfa9b69365173d84c57aac7d7386f393247e21e731fb5d0fc0b3e2a0b4/jgt_tools-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3959868fc7f8398ef658ab78aabaf041", "sha256": "53ca91c2217daa2785382e12f510ee7dad2f80397953ab3e8ff5f7555df5316f" }, "downloads": -1, "filename": "jgt_tools-0.1.4.tar.gz", "has_sig": false, "md5_digest": "3959868fc7f8398ef658ab78aabaf041", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 6684, "upload_time": "2019-07-19T21:12:29", "url": "https://files.pythonhosted.org/packages/2e/d0/6486830c854a8bd60c86f9e91d17e67c67fe882b5c67b4eb2729088b9b9e/jgt_tools-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "f9da3b3572aaed3472b5e64d954558e3", "sha256": "8b23b84b0e14fda2b1ceaafd568ec28872e998b983b7e68188e8e57415dc2385" }, "downloads": -1, "filename": "jgt_tools-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "f9da3b3572aaed3472b5e64d954558e3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 8252, "upload_time": "2019-07-21T14:42:45", "url": "https://files.pythonhosted.org/packages/55/8e/5075cdae694c284675cc1707de70afb1d4aef79999c8f80fa6c221d791b5/jgt_tools-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6d2760a05def1c3fb2a38272db6e8d0f", "sha256": "2d216630982c0d03a2290d140dd7e2df2e1492e8ac95e1ba5ced9d2fdb168983" }, "downloads": -1, "filename": "jgt_tools-0.1.5.tar.gz", "has_sig": false, "md5_digest": "6d2760a05def1c3fb2a38272db6e8d0f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 6811, "upload_time": "2019-07-21T14:42:47", "url": "https://files.pythonhosted.org/packages/61/42/40aac085a41e6a6a5ccb6be6f0d1055c580a17d8f0367e0dc8d9e48b7c78/jgt_tools-0.1.5.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "79224cda666e9f9cb675550dbe2df003", "sha256": "42e07e37df2fc2a31c5fa140dc3e5d495dc152e3e05f7aeedbff214c786b799a" }, "downloads": -1, "filename": "jgt_tools-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "79224cda666e9f9cb675550dbe2df003", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 10561, "upload_time": "2019-07-22T13:55:02", "url": "https://files.pythonhosted.org/packages/8a/37/ef996dd3da36336b2261d6567935c84884cb35968386f8fb0966f309448c/jgt_tools-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c20f2f31944dfd2c2f06bcbc0c7d3734", "sha256": "169d4dc7139d000c62e596574ec459c2ee77c98fa98de721e8332d1f1fdc7621" }, "downloads": -1, "filename": "jgt_tools-0.2.0.tar.gz", "has_sig": false, "md5_digest": "c20f2f31944dfd2c2f06bcbc0c7d3734", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9014, "upload_time": "2019-07-22T13:55:04", "url": "https://files.pythonhosted.org/packages/8b/e9/bfbcb1d050a9b09deaf9b2094ab23cd6fe4448cc73994ad30ba13a64ac81/jgt_tools-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "0748f2b4ca5a8c3502d06245d20f7084", "sha256": "3e0c3bce520dfa52c22a18fe0ea3706fd7e44bc4983ec547c512f1962b924477" }, "downloads": -1, "filename": "jgt_tools-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0748f2b4ca5a8c3502d06245d20f7084", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 10576, "upload_time": "2019-07-22T15:13:33", "url": "https://files.pythonhosted.org/packages/2e/8d/1d79e5877b043cb6a6a3477b278f663504551a75ffec65b00176efdd2b4d/jgt_tools-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "737c71783a58920b0c4edea263d470ee", "sha256": "5158cd92e6f81f4f3a790b0e02097603e20134def242b37ec339bd0dcf7c95f6" }, "downloads": -1, "filename": "jgt_tools-0.2.1.tar.gz", "has_sig": false, "md5_digest": "737c71783a58920b0c4edea263d470ee", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9029, "upload_time": "2019-07-22T15:13:34", "url": "https://files.pythonhosted.org/packages/14/f3/0cce0fb8215c8e92e109b54143fea75793374b4e0cc4e8878b02f2b2851a/jgt_tools-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "71119dc25ed517d880c0b89fceba3e04", "sha256": "c48ab548c2e623f05a9c3ca30eadb2d4fa3ae0cba057aa5a2f69e7b9fcab1430" }, "downloads": -1, "filename": "jgt_tools-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "71119dc25ed517d880c0b89fceba3e04", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 10655, "upload_time": "2019-07-22T18:06:08", "url": "https://files.pythonhosted.org/packages/b6/89/dbb8ba9cd61bd5fc3c6b4a6a77b54c3dad20f9da7339b22ac04b3cbc4bb9/jgt_tools-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a3d6bcd5a621ce984eeb4ecefa998f7e", "sha256": "8ebb5894e54d2edd5f628088c2e1b8dfe659c169eb43f49cb1ab17c23a730daa" }, "downloads": -1, "filename": "jgt_tools-0.2.2.tar.gz", "has_sig": false, "md5_digest": "a3d6bcd5a621ce984eeb4ecefa998f7e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9212, "upload_time": "2019-07-22T18:06:09", "url": "https://files.pythonhosted.org/packages/ad/58/8581e1fed0d89b529d0a47b261bbd34581b585aa18c5e0b975aec4a3fada/jgt_tools-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "cee0bb4d12356c66fbb4b572149fcb68", "sha256": "5d32cf8abb57686ac4b44c4659a3b3650813cb5b9b1f3401bd3a6499f3baa42f" }, "downloads": -1, "filename": "jgt_tools-0.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "cee0bb4d12356c66fbb4b572149fcb68", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 10711, "upload_time": "2019-07-23T12:54:41", "url": "https://files.pythonhosted.org/packages/b6/6a/237382b1810614cc8c2c3ba0c0c5a458645d64c0b2dfa4a1ecc1d1727538/jgt_tools-0.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d18a6c1efab9c9baeb07822b44b5ca0a", "sha256": "ee02678a9dc360906fa19876cfa0107607afc50c09d89dbed5dc635ae018bba2" }, "downloads": -1, "filename": "jgt_tools-0.2.3.tar.gz", "has_sig": false, "md5_digest": "d18a6c1efab9c9baeb07822b44b5ca0a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9249, "upload_time": "2019-07-23T12:54:42", "url": "https://files.pythonhosted.org/packages/23/3b/8fe1864f39ece53deed180266b73a7c3a315de4ff240e71ed5eba278fbc1/jgt_tools-0.2.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cee0bb4d12356c66fbb4b572149fcb68", "sha256": "5d32cf8abb57686ac4b44c4659a3b3650813cb5b9b1f3401bd3a6499f3baa42f" }, "downloads": -1, "filename": "jgt_tools-0.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "cee0bb4d12356c66fbb4b572149fcb68", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 10711, "upload_time": "2019-07-23T12:54:41", "url": "https://files.pythonhosted.org/packages/b6/6a/237382b1810614cc8c2c3ba0c0c5a458645d64c0b2dfa4a1ecc1d1727538/jgt_tools-0.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d18a6c1efab9c9baeb07822b44b5ca0a", "sha256": "ee02678a9dc360906fa19876cfa0107607afc50c09d89dbed5dc635ae018bba2" }, "downloads": -1, "filename": "jgt_tools-0.2.3.tar.gz", "has_sig": false, "md5_digest": "d18a6c1efab9c9baeb07822b44b5ca0a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 9249, "upload_time": "2019-07-23T12:54:42", "url": "https://files.pythonhosted.org/packages/23/3b/8fe1864f39ece53deed180266b73a7c3a315de4ff240e71ed5eba278fbc1/jgt_tools-0.2.3.tar.gz" } ] }