{ "info": { "author": "4teamwork AG", "author_email": "mailto:info@4teamwork.ch", "bugtrack_url": null, "classifiers": [ "Framework :: Plone", "Framework :: Plone :: 4.3", "Framework :: Plone :: 5.1", "License :: OSI Approved :: GNU General Public License (GPL)", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": ".. contents:: Table of Contents\n\n\nIntroduction\n============\n\nThe package ``ftw.catalogdoctor`` provides healthcheck to find\ninconsistencies in ``portal_catalog`` and surgery to remove some of them. It\ncan be run via a ``zopectl.command``.\n\n\nHealthcheck\n===========\n\nLists inconsistencies detected in ``portal_catalog``. Finds inconsistencies by\ninspecting the catalog's internal data structures. It currently uses ``paths``\n(the rid-path mapping), ``uids`` (the path-rid mapping), the ``UID`` index and\ncatalog metadata to determine if the catalog is healthy or if there are\nproblems. Healtcheck is a read-only operation and won't modify the catalog.\n\nIt can be run as follows:\n\n.. code:: sh\n\n $ bin/instance doctor healtcheck\n\n\nSurgery\n=======\n\nAttempts to fix issues found by ``healthcheck``. Will do a healtchcheck before\nsurgery, then attempt surgery and finally do a post-surgery healthcheck.\nSurgery is a write operation but changes are only committed to the database if\nthe post-surgery healtcheck yields no more health problems.\nCurrently the set of available surgery is limited to problems we have observed\nin production.\n\n\nIt can be run as follows:\n\n.. code:: sh\n\n $ bin/instance doctor surgery\n\n\nThere is also a `--dry-run` parameter that prevents committing changes.\n\n.. code:: sh\n\n $ bin/instance doctor --dry-run surgery\n\n\nInstallation\n============\n\n- Add the package to your buildout configuration:\n\n::\n\n [instance]\n eggs +=\n ...\n ftw.catalogdoctor\n\n\nCompatibility\n-------------\n\nPlone 4.3.x\nPlone 5.1.x\n\n\nDevelopment\n===========\n\n1. Fork this repo\n2. Clone your fork\n3. Shell: ``ln -s development.cfg buildout.cfg``\n4. Shell: ``python bootstrap.py``\n5. Shell: ``bin/buildout``\n\nRun ``bin/test`` to test your changes.\n\nOr start an instance by running ``bin/instance fg``.\n\n\nLinks\n=====\n\n- Github: https://github.com/4teamwork/ftw.catalogdoctor\n- Issues: https://github.com/4teamwork/ftw.catalogdoctor/issues\n- Pypi: http://pypi.python.org/pypi/ftw.catalogdoctor\n\n\nCopyright\n=========\n\nThis package is copyright by `4teamwork `_.\n\n``ftw.catalogdoctor`` is licensed under GNU General Public License, version 2.\n\nChangelog\n=========\n\n\n1.0.0 (2019-07-08)\n------------------\n\n- Initial implementation.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/4teamwork/ftw.catalogdoctor", "keywords": "ftw catalogdoctor", "license": "GPL2", "maintainer": "", "maintainer_email": "", "name": "ftw.catalogdoctor", "package_url": "https://pypi.org/project/ftw.catalogdoctor/", "platform": "", "project_url": "https://pypi.org/project/ftw.catalogdoctor/", "project_urls": { "Homepage": "https://github.com/4teamwork/ftw.catalogdoctor" }, "release_url": "https://pypi.org/project/ftw.catalogdoctor/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "ftw.catalogdoctor", "version": "1.0.0" }, "last_serial": 5823395, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "d57f48d7a6dfdb3204ad8272521458a2", "sha256": "35d537422b16513eb0d713f30dcc66bbc2a4fe698f016e691b968406513e1ef6" }, "downloads": -1, "filename": "ftw.catalogdoctor-1.0.0.tar.gz", "has_sig": false, "md5_digest": "d57f48d7a6dfdb3204ad8272521458a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26785, "upload_time": "2019-07-08T12:53:23", "url": "https://files.pythonhosted.org/packages/2a/7a/56b48d547a7fbd5186045d317e28eef8a184dd2cc2266d50244f2984a63f/ftw.catalogdoctor-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d57f48d7a6dfdb3204ad8272521458a2", "sha256": "35d537422b16513eb0d713f30dcc66bbc2a4fe698f016e691b968406513e1ef6" }, "downloads": -1, "filename": "ftw.catalogdoctor-1.0.0.tar.gz", "has_sig": false, "md5_digest": "d57f48d7a6dfdb3204ad8272521458a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26785, "upload_time": "2019-07-08T12:53:23", "url": "https://files.pythonhosted.org/packages/2a/7a/56b48d547a7fbd5186045d317e28eef8a184dd2cc2266d50244f2984a63f/ftw.catalogdoctor-1.0.0.tar.gz" } ] }