{ "info": { "author": "Dave Shawley", "author_email": "daveshawley@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Setuptools Plugin", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "janitor Setuptools Extension\n============================\n\n|Version| |Downloads| |Status| |License|\n\nExtends the ``clean`` command to remove stuff generated by the\ndevelopment process.\n\nWait... Why? What??\n-------------------\nSo ``setup.py clean`` is useful for developers of C extensions or\nanything else that takes advantage of the ``setup.py build`` command.\nPure Python packages generate their own set of artifacts that clutter\nup the source tree. This package extends the clean command so that\nit removes the following artifacts as well:\n\n* The distribution directory as generated by the ``sdist`` and ``bdist*``\n commands\n* Top-level *.egg-info* and *.egg* directories that *setup.py* creates\n* Local virtual environment directories\n* *__pycache__* directories\n\nI come from a C/C++ background where the *Makefile* usually provide house\nkeeping targets such as *clean*, *dist-clean*, and *maintainer-clean*.\nThis extension is inspired by the same desire for a clean working\nenvironment.\n\nInstallation\n~~~~~~~~~~~~\nThe ``setuptools`` package contains a number of interesting ways in which\nit can be extended. The simplest way to use this extension is to install\nit into the environment and use it. The package extends the ``clean``\ncommand by installing a `distutils extension`_::\n\n $ pip install -q 'setupext-janitor'\n $ ./setup.py clean --dist --eggs\n running clean\n removing './my_package.egg-info' (and everything under it)\n removing 'dist' (and everything under it)\n\nYou can also install the command from within your *setup.py* using the\n``setup_requires`` and ``cmdclass`` keyword parameters to the ``setup``\nfunction call. This is a little more difficult than it should be since\nthe ``setupext_janitor`` package needs to be imported into *setup.py* so\nthat it can be passed as a keyword parameter **before** it is downloaded.\nThe easiest way to do this is to catch the ``ImportError`` that happens\nif it is not already downloaded::\n\n import setuptools\n try:\n from setupext_janitor import janitor\n CleanCommand = janitor.CleanCommand\n except ImportError:\n CleanCommand = None\n\n cmd_classes = {}\n if CleanCommand is not None:\n cmd_classes['clean'] = CleanCommand\n\n setup(\n # normal parameters\n setup_requires=['setupext_janitor'],\n cmdclass=cmd_classes,\n entry_points={\n # normal parameters, ie. console_scripts[]\n 'distutils.commands': [\n ' clean = setupext_janitor.janitor:CleanCommand']\n }\n )\n\nThis approach **is not recommended** since the ``install_requires`` keyword\nwill install ``setupext_janitor`` into a target environment when installing\nyour package from a source distribution. Not to mention that amount of\ngynmastics required to safely use it from within *setup.py*,\n\nUsage\n~~~~~\nOnce the extension is installed, the ``clean`` command will accept a\nfew new command line parameters.\n\n``setup.py clean --dist``\n Removes directories that the various *dist* commands produce.\n\n``setup.py clean --eggs``\n Removes *.egg* and *.egg-info* directories.\n\n``setup.py clean --environment``\n Removes the currently active virtual environment as indicated by the\n ``$VIRTUAL_ENV`` environment variable. The name of the directory can\n also be specified using the ``--virtualenv-dir`` command line option.\n\n``setup.py clean --pycache``\n Recursively removes directories named *__pycache__*.\n\n``setup.py clean --all``\n Remove all of by-products. This is the same as using ``--dist --egg\n --environment --pycache``.\n\nWhere can I get this extension from?\n------------------------------------\n+---------------+-----------------------------------------------------+\n| Source | https://github.com/dave-shawley/setupext-janitor |\n+---------------+-----------------------------------------------------+\n| Status | https://travis-ci.org/dave-shawley/setupext-janitor |\n+---------------+-----------------------------------------------------+\n| Download | https://pypi.org/project/setupext-janitor |\n+---------------+-----------------------------------------------------+\n| Documentation | http://setupext-janitor.readthedocs.io/en/latest |\n+---------------+-----------------------------------------------------+\n| Issues | https://github.com/dave-shawley/setupext-janitor |\n+---------------+-----------------------------------------------------+\n\n.. _distutils extension: https://setuptools.readthedocs.io/en/latest\n /setuptools.html#extending-and-reusing-setuptools\n.. _setuptools: https://setuptools.readthedocs.io/en/latest/\n\n.. |Version| image:: https://img.shields.io/pypi/v/setupext-janitor.svg?\n :target: https://pypi.org/project/setupext-janitor/\n.. |Downloads| image:: https://img.shields.io/pypi/dm/setupext-janitor.svg\n :target: https://pypi.org/project/setupext-janitor/\n.. |Status| image:: https://travis-ci.org/dave-shawley/setupext-janitor.svg\n :target: https://travis-ci.org/dave-shawley/setupext-janitor\n.. |License| image:: https://img.shields.io/github/license/dave-shawley/setupext-janitor.svg\n :target: https://setupext-janitor.readthedocs.io/\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/dave-shawley/setupext-janitor", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "setupext-janitor", "package_url": "https://pypi.org/project/setupext-janitor/", "platform": "any", "project_url": "https://pypi.org/project/setupext-janitor/", "project_urls": { "Homepage": "http://github.com/dave-shawley/setupext-janitor" }, "release_url": "https://pypi.org/project/setupext-janitor/1.1.1/", "requires_dist": [ "coverage (==4.5.3) ; extra == 'dev'", "flake8 (==3.7.7) ; extra == 'dev'", "nose (==1.3.7) ; extra == 'dev'", "sphinx (==1.8.5) ; extra == 'dev'", "sphinx-rtd-theme (==0.4.3) ; extra == 'dev'", "tox (==3.9.0) ; extra == 'dev'" ], "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, != 3.4.*", "summary": "Making setup.py clean more useful.", "version": "1.1.1" }, "last_serial": 5237863, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "3fa5a360d61004e8c85014668f76f6dd", "sha256": "7ec7cb77272f81b821b1ad630cf6d850e3549a091d7bb1319ca0063ce33aada3" }, "downloads": -1, "filename": "setupext_janitor-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3fa5a360d61004e8c85014668f76f6dd", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 7738, "upload_time": "2014-11-16T20:24:56", "url": "https://files.pythonhosted.org/packages/5b/5b/3f7f0eb2ee22fa57568d8135d310dfc0216d02926049364bc53fbd94b20b/setupext_janitor-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f38172901709431324c2ebbf30efecd7", "sha256": "b8be26534d4c8dff77e0f260e5961af898ec9e40deef0726ae8275fd214e5500" }, "downloads": -1, "filename": "setupext-janitor-0.0.1.tar.gz", "has_sig": false, "md5_digest": "f38172901709431324c2ebbf30efecd7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8267, "upload_time": "2014-11-16T20:24:49", "url": "https://files.pythonhosted.org/packages/b5/79/5b74836fbe48f31ca61a1e754f5ecfd74d0fac0a8ee59d8e128ae44b2cc1/setupext-janitor-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "aa72234925b7a70a86c1fe68bb0388f0", "sha256": "0ed16832d8d9d5dad6083cdf423f4d396fada219e6c17d3b0b9513d3d31dbcde" }, "downloads": -1, "filename": "setupext_janitor-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "aa72234925b7a70a86c1fe68bb0388f0", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 7968, "upload_time": "2014-11-17T12:37:54", "url": "https://files.pythonhosted.org/packages/db/cb/68238d41c8634ee4f75692433e2fad0414506fdae391cdd8d11a9cef82b3/setupext_janitor-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4c21677aca6c44c8bb7ebbacdc4cfa3", "sha256": "afeadf99be472b15b709645e7cd1866aa754d4c34d7b82f65985ae85fa71a032" }, "downloads": -1, "filename": "setupext-janitor-0.0.2.tar.gz", "has_sig": false, "md5_digest": "f4c21677aca6c44c8bb7ebbacdc4cfa3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8454, "upload_time": "2014-11-17T12:37:51", "url": "https://files.pythonhosted.org/packages/f0/a7/3f1eb969175ee496d2be029ac1542953f892c55c324c15fa01fc17326e99/setupext-janitor-0.0.2.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "17fa0d9ad16db30dc3ca85bf63a04b99", "sha256": "e0dd92fff4cc34cd1514e3f8a7c89e3540e24a107576a70f1f8dede0f025d0db" }, "downloads": -1, "filename": "setupext_janitor-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "17fa0d9ad16db30dc3ca85bf63a04b99", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 8478, "upload_time": "2014-11-20T03:13:24", "url": "https://files.pythonhosted.org/packages/4d/37/962fd314dba9956f47fb5e206fa3f1a46a903ab2512dd412eeb579f27083/setupext_janitor-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6061ba6a21ed8b9db3c0661255f61f3e", "sha256": "8eecfac00275a31240e148aad95c20614146b3b777c3b0055d1ccb1f07d455be" }, "downloads": -1, "filename": "setupext-janitor-1.0.0.tar.gz", "has_sig": false, "md5_digest": "6061ba6a21ed8b9db3c0661255f61f3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9922, "upload_time": "2014-11-20T03:13:22", "url": "https://files.pythonhosted.org/packages/d3/49/5fbf2babab5678b573b3639c5babbd3df480452c0c1fbfc5f2aa862af3c2/setupext-janitor-1.0.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "7b2151f7afd14ab0e3f861157f11f223", "sha256": "cb7c071785e1555bef5949cd322f37c2101ea475c8668c6119a697b8cde51966" }, "downloads": -1, "filename": "setupext_janitor-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7b2151f7afd14ab0e3f861157f11f223", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, != 3.4.*", "size": 7247, "upload_time": "2019-05-07T11:54:31", "url": "https://files.pythonhosted.org/packages/83/99/0d8896d9b477260cb8a4f2bb0f372a77d63bb1c2c612c053709b2022e4d5/setupext_janitor-1.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9eda4c16c4a3d9e11966432ede7fdc9b", "sha256": "fee46795d797dbd25be8aaf450d0a0d9d3ed248070fe706ecf8cd9f740f49e35" }, "downloads": -1, "filename": "setupext-janitor-1.1.1.tar.gz", "has_sig": false, "md5_digest": "9eda4c16c4a3d9e11966432ede7fdc9b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, != 3.4.*", "size": 9839, "upload_time": "2019-05-07T11:54:32", "url": "https://files.pythonhosted.org/packages/3b/a4/221b5c3bca27be79d192fc51ecb9f5a4651c414c2dd14a735463f47b7753/setupext-janitor-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7b2151f7afd14ab0e3f861157f11f223", "sha256": "cb7c071785e1555bef5949cd322f37c2101ea475c8668c6119a697b8cde51966" }, "downloads": -1, "filename": "setupext_janitor-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7b2151f7afd14ab0e3f861157f11f223", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, != 3.4.*", "size": 7247, "upload_time": "2019-05-07T11:54:31", "url": "https://files.pythonhosted.org/packages/83/99/0d8896d9b477260cb8a4f2bb0f372a77d63bb1c2c612c053709b2022e4d5/setupext_janitor-1.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9eda4c16c4a3d9e11966432ede7fdc9b", "sha256": "fee46795d797dbd25be8aaf450d0a0d9d3ed248070fe706ecf8cd9f740f49e35" }, "downloads": -1, "filename": "setupext-janitor-1.1.1.tar.gz", "has_sig": false, "md5_digest": "9eda4c16c4a3d9e11966432ede7fdc9b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, != 3.4.*", "size": 9839, "upload_time": "2019-05-07T11:54:32", "url": "https://files.pythonhosted.org/packages/3b/a4/221b5c3bca27be79d192fc51ecb9f5a4651c414c2dd14a735463f47b7753/setupext-janitor-1.1.1.tar.gz" } ] }