{ "info": { "author": "Alexander Kavanaugh", "author_email": "alex@kavdev.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "==================\npython-doc-inherit\n==================\nUtilities to inherit method documentation from parent classes.\n\nBadges\n------\n\n.. image:: https://img.shields.io/travis/kavdev/python-doc-inherit/master.svg?style=flat-square\n :target: https://travis-ci.org/kavdev/python-doc-inherit\n.. image:: https://img.shields.io/codecov/c/github/kavdev/python-doc-inherit/master.svg?style=flat-square\n :target: http://codecov.io/github/kavdev/python-doc-inherit?branch=master\n.. image:: https://img.shields.io/requires/github/kavdev/python-doc-inherit.svg?style=flat-square\n :target: https://requires.io/github/kavdev/python-doc-inherit/requirements/?branch=master\n.. image:: https://img.shields.io/codacy/75dbe2685efe47c3aa203a53154c9e7e.svg?style=flat-square\n :target: https://www.codacy.com/app/kavanaugh-development/python-doc-inherit/dashboard\n\n.. image:: https://img.shields.io/pypi/v/python-doc-inherit.svg?style=flat-square\n :target: https://pypi.python.org/pypi/python-doc-inherit\n.. image:: https://img.shields.io/pypi/dw/python-doc-inherit.svg?style=flat-square\n :target: https://pypi.python.org/pypi/python-doc-inherit\n\n.. image:: https://img.shields.io/github/issues/kavdev/python-doc-inherit.svg?style=flat-square\n :target: https://github.com/kavdev/python-doc-inherit/issues\n.. image:: https://img.shields.io/github/license/kavdev/python-doc-inherit.svg?style=flat-square\n :target: https://github.com/kavdev/python-doc-inherit/blob/master/LICENSE\n\nInstallation\n------------\n\nInstall python-doc-inherit:\n\n.. code-block:: bash\n\n pip install python-doc-inherit\n\nUsage\n-----\n\nSimple method decorator (will cause other decorators to fail)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n from doc_inherit import method_doc_inherit\n\n class Foo(object):\n\n def foo(self):\n \"\"\"Frobber\"\"\"\n\n pass\n \n class Bar(Foo):\n\n @method_doc_inherit\n def foo(self):\n pass\n\nNow, ``Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == \"Frobber\"``\n\n\nSimple class decorator\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n from doc_inherit import class_doc_inherit\n\n class Foo(object):\n\n def foo(self):\n \"\"\"Frobber\"\"\"\n\n pass\n\n @class_doc_inherit \n class Bar(Foo):\n\n def foo(self):\n pass\n\nNow, ``Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == \"Frobber\"``\n\n\nMetaclass\n~~~~~~~~~\n\n.. code-block:: python\n\n from doc_inherit.metaclasses import DocStringInheritor\n from six import add_metaclass # Note: Six is not included in this distribution.\n\n class Animal:\n def move_to(self, dest):\n \"\"\"Move to *dest*\"\"\"\n pass\n\n @add_metaclass(DocStringInheritor)\n class Bird(Animal):\n def move_to(self, dest):\n pass\n\nNow, ``Animal.move_to.__doc__ == Bird.move_to.__doc__ == \"Move to *dest*\"``\n\n\nRunning the Tests\n------------------\n\n.. code-block:: bash\n\n pip install -r requirements/test.txt\n ./runtests.py\n\n\n\n\n\nChanges\n=======\n\n0.1.1 (2016-06-18)\n----------------------\n\n* small fixes\n\n0.1.0 (2016-06-18)\n----------------------\n\n* Initial release", "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/kavdev/python-doc-inherit/", "keywords": "doc_inherit doc inherit", "license": "License :: OSI Approved :: MIT License", "maintainer": null, "maintainer_email": null, "name": "python-doc-inherit", "package_url": "https://pypi.org/project/python-doc-inherit/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/python-doc-inherit/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/kavdev/python-doc-inherit/" }, "release_url": "https://pypi.org/project/python-doc-inherit/0.3.0/", "requires_dist": null, "requires_python": null, "summary": "Utilities to inherit method documentation from parent classes.", "version": "0.3.0" }, "last_serial": 2180421, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d9d3d59a013182210126406ba90625fd", "sha256": "41595de28050284c41503ab4f7b0b3a5e901027b1002cf34b8d04f7fc9e83226" }, "downloads": -1, "filename": "python_doc_inherit-0.1.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "d9d3d59a013182210126406ba90625fd", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4576, "upload_time": "2016-06-19T04:02:14", "url": "https://files.pythonhosted.org/packages/26/21/1332806b8f274693830d85701b689ba506d7818d76a40203ee8315eaa270/python_doc_inherit-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5a8593bb037c51b1bf42512d08123aee", "sha256": "a4a161d66b55801f996a6bb5f07cbf519cad31d475567b68287b4717bc194b85" }, "downloads": -1, "filename": "python-doc-inherit-0.1.0.tar.gz", "has_sig": true, "md5_digest": "5a8593bb037c51b1bf42512d08123aee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5171, "upload_time": "2016-06-19T04:02:08", "url": "https://files.pythonhosted.org/packages/46/17/d1d5c7adb9be01d1b29247127795cab7ae47ab3e4b588afbade8851a1e6d/python-doc-inherit-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "c0902bf177f26d0b4b796c7e5ed40c0e", "sha256": "71b4039a7009cdfec5f23fbb7d70a6e95f32477bcf9e9d02e5468b034bfc16db" }, "downloads": -1, "filename": "python_doc_inherit-0.1.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "c0902bf177f26d0b4b796c7e5ed40c0e", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4604, "upload_time": "2016-06-19T04:23:43", "url": "https://files.pythonhosted.org/packages/d3/ea/8411258c98baa8a63bc3b24e2925fa3406dd07ab0000504ae0e20ec38bab/python_doc_inherit-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "80333e151501eb066b0679ac1dee4938", "sha256": "30a5b4f9d219a75e6396f53d331b454c64b5394168e38bf41b9a1c87e098b5dc" }, "downloads": -1, "filename": "python-doc-inherit-0.1.1.tar.gz", "has_sig": true, "md5_digest": "80333e151501eb066b0679ac1dee4938", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5204, "upload_time": "2016-06-19T04:23:37", "url": "https://files.pythonhosted.org/packages/30/e5/220b5bc847d65418fe3d28db75ee681c7d450d74fa60698fa5c379865c33/python-doc-inherit-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "1a8da343bdcd835f85990f53dcc98fdb", "sha256": "098660cc188b16cfeb9ce83cb17b3366b646298fd4f8f5f84ba66c2ce3c884a3" }, "downloads": -1, "filename": "python_doc_inherit-0.2.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "1a8da343bdcd835f85990f53dcc98fdb", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 5642, "upload_time": "2016-06-22T00:57:26", "url": "https://files.pythonhosted.org/packages/37/0e/62327265f2ab5d898e1a396b10df04fccf64a706a903022db328387144ef/python_doc_inherit-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "79d119c2233487a644cce5613ebb77ab", "sha256": "609f0547e26b33827d5dab598afd7991ca8cd241bdd545854a36b75a47ae8c30" }, "downloads": -1, "filename": "python-doc-inherit-0.2.0.tar.gz", "has_sig": true, "md5_digest": "79d119c2233487a644cce5613ebb77ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5866, "upload_time": "2016-06-22T00:57:21", "url": "https://files.pythonhosted.org/packages/5f/49/c4b64e9381ede7df5800f62e1932e3b4e16baccc5777e8a177d16ef76dba/python-doc-inherit-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "dcb762e5e75b725aca1987e00868c265", "sha256": "588ad773a64d9a0f20cb7edf22a7d7c5421996744b0f024f042524f5fc7d226f" }, "downloads": -1, "filename": "python_doc_inherit-0.3.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "dcb762e5e75b725aca1987e00868c265", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 5882, "upload_time": "2016-06-22T03:43:00", "url": "https://files.pythonhosted.org/packages/74/a9/46749cd2d28b7b566d240fecb0293e3b5af3741e8f25517d3677329ee545/python_doc_inherit-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4087e29e97795d8d789e2403dbee68d", "sha256": "99aa5f18ceb07463128bb1fd33f43a8b789b89b7dc1033a783ee5c41fdf31fa7" }, "downloads": -1, "filename": "python-doc-inherit-0.3.0.tar.gz", "has_sig": true, "md5_digest": "f4087e29e97795d8d789e2403dbee68d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6067, "upload_time": "2016-06-22T03:42:55", "url": "https://files.pythonhosted.org/packages/41/b6/763d2474e0ed3946f470513f0ee61b5be7921880a2421b311810049d8881/python-doc-inherit-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "dcb762e5e75b725aca1987e00868c265", "sha256": "588ad773a64d9a0f20cb7edf22a7d7c5421996744b0f024f042524f5fc7d226f" }, "downloads": -1, "filename": "python_doc_inherit-0.3.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "dcb762e5e75b725aca1987e00868c265", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 5882, "upload_time": "2016-06-22T03:43:00", "url": "https://files.pythonhosted.org/packages/74/a9/46749cd2d28b7b566d240fecb0293e3b5af3741e8f25517d3677329ee545/python_doc_inherit-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4087e29e97795d8d789e2403dbee68d", "sha256": "99aa5f18ceb07463128bb1fd33f43a8b789b89b7dc1033a783ee5c41fdf31fa7" }, "downloads": -1, "filename": "python-doc-inherit-0.3.0.tar.gz", "has_sig": true, "md5_digest": "f4087e29e97795d8d789e2403dbee68d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6067, "upload_time": "2016-06-22T03:42:55", "url": "https://files.pythonhosted.org/packages/41/b6/763d2474e0ed3946f470513f0ee61b5be7921880a2421b311810049d8881/python-doc-inherit-0.3.0.tar.gz" } ] }