{ "info": { "author": "Fulvio Casali", "author_email": "fulviocasali@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Plone", "Framework :: Plone :: 4.3", "Framework :: Plone :: 5.0", "Framework :: Plone :: 5.1", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": ".. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html\n This text does not appear on pypi or github. It is a comment.\n\n=================================\ncollective.restapi.navigationtree\n=================================\n\n.. image:: http://img.shields.io/pypi/v/collective.restapi.navigationtree.svg\n :target: https://pypi.python.org/pypi/collective.restapi.navigationtree\n\n.. image:: https://img.shields.io/travis/collective/collective.restapi.navigationtree/master.svg\n :target: http://travis-ci.org/collective/collective.restapi.navigationtree\n\n.. image:: https://img.shields.io/coveralls/collective/collective.restapi.navigationtree/master.svg\n :target: https://coveralls.io/r/collective/collective.restapi.navigationtree\n\n\nThis Plone plugin provides a REST endpoint to query the site's navigation tree.\nThe endpoint name is ``@navigationtree``,\nand can be considered an extension to ``plone.restapi``'s ``@navigation`` endpoint, \nsince the latter only returns the top level navigation menu items.\n``collective.restapi.navigationtree`` depends on the ``webcouturier.dropdownmenu`` plugin to build the navigation tree,\nand honors the same configuration settings as ``webcouturier.dropdownmenu``.\nThus, the maximum depth of the tree can be set in the ``webcouturier.dropdownmenu`` configlet.\n\nTested on Plone 4.3, 5.0 and 5.1 with Archetypes and Dexterity.\n\n\nFeatures\n--------\n\n- Simply ``GET @navigationtree``\n- Extends the ``@navigation`` endpoint of ``plone.restapi`` by building a full navigation tree of the site, instead of limiting itself to just the top level navigation menu.\n- Depends on ``webcouturier.dropdownmenu``, thus is ideal for sites that already use this plugin for their navigation menu.\n- Honors all the configuration settings in Plone's _Navigation_ control panel.\n- Honors all the configuration settings in ``@@dropdown-controlpanel``.\n- In particular, you can set the depth of the navigation tree in ``webcouturier.dropdownmenu``'s configlet.\n\n\nExamples\n--------\n\nGetting the navigation tree::\n\n GET /plone/@navigationtree HTTP/1.1\n Accept: application/json\n Authorization: Basic YWRtaW46c2VjcmV0\n\n(Authorization is optional.)\n\nExample response::\n\n {\n \"@id\": \"http://localhost:8080/Plone/@navigationtree\",\n \"items\": [\n {\n \"@id\": \"http://localhost:8080/Plone\",\n \"description\": \"\",\n \"items\": \"\",\n \"title\": \"Home\"\n },\n {\n \"@id\": \"http://localhost:8080/Plone/news\",\n \"description\": \"Site News\",\n \"items\": [\n {\n \"@id\": \"http://localhost:8080/Plone/news/some-news\",\n \"description\": \"\",\n \"title\": \"Some News\"\n }\n ],\n \"title\": \"News\"\n },\n {\n \"@id\": \"http://localhost:8080/Plone/events\",\n \"description\": \"Site Events\",\n \"items\": [],\n \"title\": \"Events\"\n },\n {\n \"@id\": \"http://localhost:8080/Plone/Members\",\n \"description\": \"Site Users\",\n \"items\": [],\n \"title\": \"Users\"\n }\n ]\n }\n\nInstallation\n------------\n\nInstall collective.restapi.navigationtree by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n collective.restapi.navigationtree\n\n\nand then running ``bin/buildout``. \nThis will automatically install webcouturier.dropdownmenu and plone.restapi,\nso you should pin the versions of these add-ons according to the version of Plone you are running.\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.restapi.navigationtree/issues\n- Source Code: https://github.com/collective/collective.restapi.navigationtree\n- Documentation: https://docs.plone.org/foo/bar\n\n\nSupport\n-------\n\nIf you are having issues, please let us know in the issue tracker.\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\nContributors\n============\n\n- Fulvio Casali, fulviocasali@gmail.com\n\n\nChangelog\n=========\n\n\n1.0a1 (2018-03-12)\n------------------\n\n- Initial release.\n [fulv]", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://pypi.python.org/pypi/collective.restapi.navigationtree", "keywords": "Python Plone rest restful api json", "license": "GPL version 2", "maintainer": "", "maintainer_email": "", "name": "collective.restapi.navigationtree", "package_url": "https://pypi.org/project/collective.restapi.navigationtree/", "platform": "", "project_url": "https://pypi.org/project/collective.restapi.navigationtree/", "project_urls": { "Homepage": "https://pypi.python.org/pypi/collective.restapi.navigationtree" }, "release_url": "https://pypi.org/project/collective.restapi.navigationtree/1.0a1/", "requires_dist": null, "requires_python": "", "summary": "Provides a REST endpoint to query the site's navigation tree", "version": "1.0a1" }, "last_serial": 3663399, "releases": { "1.0a1": [ { "comment_text": "", "digests": { "md5": "395fbeb1efbedc2c3cd5043bb6f13580", "sha256": "805eff65f58fd1ac3d20997b7fc5a374664c92c7b13659ab5df5993c7e5bc05b" }, "downloads": -1, "filename": "collective.restapi.navigationtree-1.0a1.tar.gz", "has_sig": false, "md5_digest": "395fbeb1efbedc2c3cd5043bb6f13580", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11501, "upload_time": "2018-03-12T22:07:09", "url": "https://files.pythonhosted.org/packages/ff/36/06e1174a6934983f8a525c5e397cefa001626ad99a7dc3ff6a1ff7eececa/collective.restapi.navigationtree-1.0a1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "395fbeb1efbedc2c3cd5043bb6f13580", "sha256": "805eff65f58fd1ac3d20997b7fc5a374664c92c7b13659ab5df5993c7e5bc05b" }, "downloads": -1, "filename": "collective.restapi.navigationtree-1.0a1.tar.gz", "has_sig": false, "md5_digest": "395fbeb1efbedc2c3cd5043bb6f13580", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11501, "upload_time": "2018-03-12T22:07:09", "url": "https://files.pythonhosted.org/packages/ff/36/06e1174a6934983f8a525c5e397cefa001626ad99a7dc3ff6a1ff7eececa/collective.restapi.navigationtree-1.0a1.tar.gz" } ] }