{ "info": { "author": "Phillip J. Eby", "author_email": "peak@eby-sarna.com", "bugtrack_url": null, "classifiers": [ "Framework :: Setuptools Plugin" ], "description": "==================================================\nUpdating Project Wiki Pages from Docs using WikiUp\n==================================================\n\nNEW in 1.1:\n The ``--changed-file`` or ``-f`` option now lets you specify a single\n file to upload. (See `Command-Line Usage`_ below for details.)\n\nThe WikiUp project defines a setuptools extension to allow uploading Wiki\npages from source documentation. It's primarily intended to be useful for\nPEAK projects to update the PEAK Wiki, but other projects could make use of\nthe same basic framework.\n\nInstalling this project adds a ``wikiup`` command to setuptools-based packages.\nBy default, this command will read a file called ``wikiup.cfg`` in the project\ndirectory containing content like this::\n\n [wikiname]\n pagename = filename\n\nIn other words, a file with a section for each wiki, and a pagename + filename\non each line. (The filename is actually optional; if you just list a pagename\nwithout an ``=``, the filename will be assumed to be the same as the page\nname.) Filenames must be relative to the setup directory, and use ``/`` as\na separator, as they will be converted to an OS path using the distutils\n``convert_path()`` function.\n\nTo configure a Wiki, you need to add it to a distutils config file (usually\nyour ``$HOME/pydistutils.cfg`` or ``~/.pydistutils.cfg`` file) like so::\n\n [wikiup-wikiname]\n url = base url here\n type = plugin name here\n ... other settings, if any\n\nIn other words, for each wiki, you need a ``[wikiup-foo]`` section, where\n``foo`` is the name of the wiki as it will appear in some project's\n``wikiup.cfg`` file.\n\nThe ``url`` is the Wiki's base URL, and ``type`` is the name of the plugin to\nbe used to do the uploading. Currently, the only supported value for ``type``\nis ``OldMoin``, which works with the old MoinMoin wiki used by the PEAK\nprojects.\n\n\nCommand-Line Usage\n------------------\n\nThe ``setup.py wikiup`` command optionally takes a ``--comment`` or ``-c``\noption to specify an update comment to apply when editing. It can also be\ngiven ``--config-file`` or ``-C`` to specify an alternate config file in place\nof the local ``wikiup.cfg`` file.\n\nAlso, if you have many wiki pages, you can specify just a single filename to\nupdate, using ``--changed-file`` or ``-f``. The file will be uploaded to all\nthe matching pages in the project's ``wikiup.cfg``. (Note: this option is\ncase-sensitive and must exactly match one or more filenames in ``wikiup.cfg``,\nor nothing will be uploaded.)\n\n\nThe ``OldMoin`` Plugin\n----------------------\n\nThe ``OldMoin`` plugin takes two optional arguments in its configuration\nsection, in addition to the required ``type`` and ``url``::\n\n [wikiup-foo]\n\n type = OldMoin\n url = something\n\n uid = login.id.goes.here\n page_format = {{{ %s }}}\n\nThe ``uid`` allows you to specify a MoinMoin login ID to use; if specified,\nthe plugin will use the ``userform`` Wiki action to log in as that ID before\nuploading any pages.\n\nThe ``page_format`` is a format string (defaulting to ``\"#format rst\\n%s\"``)\nthat will be used to convert the raw upload file into the page text that will\nbe posted to the wiki. The string is interpreted using the ``string_escape``\ncodec, so you will need to double-up on backslashes to keep them from being\ntreated as character escapes.\n\n\nAdding Plugins\n--------------\n\nYou can implement alternative plugins for other wiki types, by subclassing\n``wikiup.Wiki`` and registering the resulting class in the ``wikiup.plugins``\nentry point group. See the source code for details of what the plugin must be\nable to do.\n\n\nSupport\n-------\n\nQuestions, comments, and bug reports for this package should be directed to the\n`PEAK mailing list`_.\n\n.. _PEAK mailing list: http://www.eby-sarna.com/mailman/listinfo/peak/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://cheeseshop.python.org/pypi/WikiUp", "keywords": null, "license": "PSF or ZPL", "maintainer": null, "maintainer_email": null, "name": "WikiUp", "package_url": "https://pypi.org/project/WikiUp/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/WikiUp/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://cheeseshop.python.org/pypi/WikiUp" }, "release_url": "https://pypi.org/project/WikiUp/1.1/", "requires_dist": null, "requires_python": null, "summary": "Wiki page uploading command plugin for setuptools", "version": "1.1" }, "last_serial": 786014, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "4786ccccf6ea82cd709a4ab04d70bc42", "sha256": "fedb670e907078bb28421e6af396dfce29e8c0b3261d5bdb60409453d570938b" }, "downloads": -1, "filename": "WikiUp-1.0-py2.3.egg", "has_sig": false, "md5_digest": "4786ccccf6ea82cd709a4ab04d70bc42", "packagetype": "bdist_egg", "python_version": "2.3", "requires_python": null, "size": 25692, "upload_time": "2008-04-29T16:19:54", "url": "https://files.pythonhosted.org/packages/96/ec/92b5ec12f36eb3f5f0d1841a84742edbfc5fbcab6a1b4a1cf10576b3e992/WikiUp-1.0-py2.3.egg" }, { "comment_text": "", "digests": { "md5": "f9ea78c771ce315abf7e545bebd62eba", "sha256": "666a8d611af03c6143473ee1c06a6926dc196e1d38ca89160e6d5044602c0723" }, "downloads": -1, "filename": "WikiUp-1.0-py2.4.egg", "has_sig": false, "md5_digest": "f9ea78c771ce315abf7e545bebd62eba", "packagetype": "bdist_egg", "python_version": "2.4", "requires_python": null, "size": 10680, "upload_time": "2008-04-29T16:20:04", "url": "https://files.pythonhosted.org/packages/50/d6/1af4afe4ac3a2cffa9ca16d996f3f1024fbd8e282772e8da9e6df89e128f/WikiUp-1.0-py2.4.egg" }, { "comment_text": "", "digests": { "md5": "0379213c8afddb455cc2f065b84055b0", "sha256": "f48a87db3707a55b4dfb5b95023071eaab8880cb49c7fe5a4570f466d5daa2a0" }, "downloads": -1, "filename": "WikiUp-1.0-py2.5.egg", "has_sig": false, "md5_digest": "0379213c8afddb455cc2f065b84055b0", "packagetype": "bdist_egg", "python_version": "2.5", "requires_python": null, "size": 10568, "upload_time": "2008-04-29T16:20:14", "url": "https://files.pythonhosted.org/packages/19/ac/618cd19e444d992584ed0558feffccf83e4c53412047533b297d1470aa24/WikiUp-1.0-py2.5.egg" }, { "comment_text": "", "digests": { "md5": "ba47d50028822b01ffbd0f0c791bfbca", "sha256": "766e7c906b67e0047a00666cfc0da72a02a4fd2f4bac60280d4fb0963d811963" }, "downloads": -1, "filename": "WikiUp-1.0.zip", "has_sig": false, "md5_digest": "ba47d50028822b01ffbd0f0c791bfbca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9285, "upload_time": "2008-04-29T16:19:52", "url": "https://files.pythonhosted.org/packages/60/39/92eca9186d5b587998c2941f102a6000894ef292132f438b0b81f975a397/WikiUp-1.0.zip" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "c08bda275bb5423fabde10b55bc5bae0", "sha256": "f470bfb44be440f3309a1c09be7399870d8f995d1230a07401c77bdd0d8daf7a" }, "downloads": -1, "filename": "WikiUp-1.1.zip", "has_sig": false, "md5_digest": "c08bda275bb5423fabde10b55bc5bae0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9934, "upload_time": "2010-08-12T01:36:48", "url": "https://files.pythonhosted.org/packages/08/58/2cc71b2b32730f954f8d06ef80b9a1c9ef65449d065627ef062c31da4532/WikiUp-1.1.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c08bda275bb5423fabde10b55bc5bae0", "sha256": "f470bfb44be440f3309a1c09be7399870d8f995d1230a07401c77bdd0d8daf7a" }, "downloads": -1, "filename": "WikiUp-1.1.zip", "has_sig": false, "md5_digest": "c08bda275bb5423fabde10b55bc5bae0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9934, "upload_time": "2010-08-12T01:36:48", "url": "https://files.pythonhosted.org/packages/08/58/2cc71b2b32730f954f8d06ef80b9a1c9ef65449d065627ef062c31da4532/WikiUp-1.1.zip" } ] }