{ "info": { "author": "Artem Dayneko", "author_email": "dayneko.ab@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python" ], "description": "rst2wiki\n========\n\nrst2wiki is command line utility for pushing your documentation\nin reStructuredText format to Confluence wiki. Under the covers\nit uses `rst2confluence `_\nlibrary for transforming ReST files and pushes result using\n`Confluence REST API `_.\n\n\nInstallation\n------------\n\nIt is available through PyPI::\n\n pip install rst2wiki\n\nor getting more popular recently::\n\n python -m pip install rst2wiki\n\nPersonally, I recommend to use `pipsi `_::\n\n pipsi install rst2wiki\n\nIt works under Mac OS X and Linux on Python versions 2.7 and 2.6.\n\n\nUsage\n-----\n\nrst2wiki supports two use cases: (1) updating existing page in Confluence\nand (2) creating new page.\n\nFirst time it will ask you for some configuration values:\nConfluence url (don't forget ``https://`` part), your login and password\nand store it for further usage (password storage is optional).\n\nAssuming you want to create page first from your ReST source, invocation\ncould be as follows (note option ``--create``)::\n\n rst2wiki --create --ancestor 1147842 --title 'Project overview' documentation.rst\n\nMost options are, not surprisingly, optional.\n\nAncestor option takes page id, under which you want to place new page\n(it will be parent to new page, so to speak).\nIf not presented, page will be created in your personal space.\nPage id of existing page you can find in URL of page, after you click on 'Edit'\n(in some cases Confluence shows page id without any tricks\n-- if it was set up to do so or page has some unicode symbols in title).\n\nTitle option sets header of new page in Confluence. If not specified\nin command line, tool takes first heading of document as option value.\n\nUpdate of page is executed as follows (page id in this case is mandatory)::\n\n rst2wiki --page 10814244 --ancestor 1147842 documentation.rst\n\nSadly, Confluence REST API for current version (5.8.6) does not return\nancestors in page resource representation, so we need to provide it every time on\npage update or our updated page will move to space's root.\n\nThere are some more options: ``--warning`` (adds warning to top of your page\nthat this page is autogenerated and manual revisions will be overwritten),\n``--title`` to update page title in confluence (use exiting, if not specified)\nand ``--config`` for configuration file location.\n\nMore interesting, it is possible to embed all arguments (except ``config`` and ``create``)\nin ReST document by adding comment in the following form::\n\n .. rst2wiki\n\n :page: 10814244\n :ancestor: 1147842\n :title: Project overview\n :warning: en\n\nAfter that you can use tool as follows::\n\n rst2wiki documentation.rst\n\nOf course, you still can override document metadata in command line::\n\n rst2wiki --warning off documentation.rst\n", "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/jamert/rst2wiki", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "rst2wiki", "package_url": "https://pypi.org/project/rst2wiki/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rst2wiki/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/jamert/rst2wiki" }, "release_url": "https://pypi.org/project/rst2wiki/0.3.1/", "requires_dist": null, "requires_python": null, "summary": "Tool to push reST docs to confluence", "version": "0.3.1" }, "last_serial": 2556853, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "b8dc3e0cf76049241c6d631bdf2afdcd", "sha256": "d1eb7ef46d7020da6c9f7e59b399c6fbb5436d559463904ab1af2d67d0b95076" }, "downloads": -1, "filename": "rst2wiki-0.2.0-py2-none-any.whl", "has_sig": false, "md5_digest": "b8dc3e0cf76049241c6d631bdf2afdcd", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 5216, "upload_time": "2015-11-02T01:17:35", "url": "https://files.pythonhosted.org/packages/40/3a/8552b887813b2897cfb1ea77cf9eb7b6b87dd1f9b60fcece6b4672c4ce18/rst2wiki-0.2.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1a5f8fa00bf32d9dd4d9051486fde92c", "sha256": "ef1fca7fe3b72e1ad79f5cd069247a3c382711e55d0f56335a73a0664e1d1e57" }, "downloads": -1, "filename": "rst2wiki-0.2.0.tar.gz", "has_sig": false, "md5_digest": "1a5f8fa00bf32d9dd4d9051486fde92c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4639, "upload_time": "2015-11-02T01:17:30", "url": "https://files.pythonhosted.org/packages/7d/de/b9eecad8dd37aab745a0443cc96b13184f09aa58deeb7bb791fd6b08750c/rst2wiki-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "7b6f2f29b40bb7ddb03238737ac9440c", "sha256": "deff49c5d0eb1f510bf926c285f0bfd6825925ba43cdf9124f30a18f9d2086c4" }, "downloads": -1, "filename": "rst2wiki-0.3.0-py2-none-any.whl", "has_sig": false, "md5_digest": "7b6f2f29b40bb7ddb03238737ac9440c", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 5848, "upload_time": "2015-11-15T22:53:08", "url": "https://files.pythonhosted.org/packages/b0/94/ed2e6340e3c9b4adcd8c0041aca114180dc70d77d1422ce14f17d8d85bee/rst2wiki-0.3.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6aea5dcccb847b94d4443c480a414570", "sha256": "c054fae5beb4432c7974b11b343402dd98b34e5a82afee467d7b2f838706a3f8" }, "downloads": -1, "filename": "rst2wiki-0.3.0.tar.gz", "has_sig": false, "md5_digest": "6aea5dcccb847b94d4443c480a414570", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5643, "upload_time": "2015-11-15T22:53:02", "url": "https://files.pythonhosted.org/packages/6c/65/1d8e8f0fc1737221557d4962d4c20acb9d395ab29c82ca9688c8bfc95ba0/rst2wiki-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "00e222c0737b7764ebe25aaedfd7f976", "sha256": "7cc2ca43423ffcaef024f3157970d9503a0731df3247f8b303103aa5b53f990e" }, "downloads": -1, "filename": "rst2wiki-0.3.1.tar.gz", "has_sig": false, "md5_digest": "00e222c0737b7764ebe25aaedfd7f976", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5842, "upload_time": "2017-01-06T00:45:24", "url": "https://files.pythonhosted.org/packages/49/c3/530c4c84f8a602eb742818374deca79b2828b5aa350653e8649cc4ee91c3/rst2wiki-0.3.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "00e222c0737b7764ebe25aaedfd7f976", "sha256": "7cc2ca43423ffcaef024f3157970d9503a0731df3247f8b303103aa5b53f990e" }, "downloads": -1, "filename": "rst2wiki-0.3.1.tar.gz", "has_sig": false, "md5_digest": "00e222c0737b7764ebe25aaedfd7f976", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5842, "upload_time": "2017-01-06T00:45:24", "url": "https://files.pythonhosted.org/packages/49/c3/530c4c84f8a602eb742818374deca79b2828b5aa350653e8649cc4ee91c3/rst2wiki-0.3.1.tar.gz" } ] }