{ "info": { "author": "Arello Mobile", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Documentation" ], "description": "Confluence Publisher\n====================\n\n|Build Status|\n\nSet of tools to help publish documentation to Confluence. It includes:\n\n- conf\\_publisher\n- conf\\_page\\_maker\n- conf\\_page\\_dumper\n\nThis tools use own configuration file.\n\nFor now it supports:\n\n- confluence versions: 5.5 - 5.9\n- sphinx-build formats: \"fjson\", \"html\"\n\nWhy?\n----\n\nThis tools are written as part of our Documentation Toolkit which we use\nin our job daily. The main idea of toolkit is to make a process of\ncreating and updating documentation able to be automated\n\nOther parts of our toolkit is:\n\n- `py2swagger `__\n- `swagger2rst `__\n- `sphinx-confluence `__\n- `confluence-publisher `__\n\nInstall\n=======\n\nInstall Confluence Publisher from\n`PyPI `__ with\n\n::\n\n $ pip install confluence-publisher\n\nPublisher\n---------\n\n::\n\n $ conf_publisher config.yml --auth XXXXXjpwYXNzdXXXXX==\n\nIf a config doesn't contain page.id, you can use ``conf_page_maker``\ncommand to create a page and page ID will be put into config\nautomatically.\n\n::\n\n usage: conf_publisher [-h] [-u URL] [-a AUTH] [-F] [-w WATERMARK] [-l LINK]\n [-ht] [-v]\n config\n\n Publish documentation (Sphinx fjson) to Confluence\n\n positional arguments:\n config Configuration file\n\n optional arguments:\n -h, --help show this help message and exit\n -u URL, --url URL Confluence Url\n -a AUTH, --auth AUTH Base64 encoded user:password string\n -F, --force Publish not changed page.\n -w WATERMARK, --watermark WATERMARK\n Overrides the watermarks. Also can be \"False\" to\n remove all watermarks; or \"True\" to add watermarkswith\n default text: \"Automatically generated content. Do not\n edit directly.\" on all pages.\n -l LINK, --link LINK Overrides page link. If value is \"False\" then removes\n the link.\n -ht, --hold-titles Do not change page titles while publishing.\n -v, --verbose\n\nPage Maker\n----------\n\n::\n\n $ conf_page_maker config.yml --auth XXXXXjpwYXNzdXXXXX== --parent-id 52332132\n\n::\n\n usage: conf_page_maker [-h] [-u URL] [-a AUTH] [-pid PARENT_ID] [-v] config\n\n Create Confluence pages and update configuration file with it ids\n\n positional arguments:\n config Configuration file\n\n optional arguments:\n -h, --help show this help message and exit\n -u URL, --url URL Confluence Url\n -a AUTH, --auth AUTH Base64 encoded user:password string. Required.\n -pid PARENT_ID, --parent-id PARENT_ID\n Parent page ID in confluence.\n -v, --verbose\n\nPage dumper\n-----------\n\n::\n\n usage: conf_page_dumper [-h] [-u URL] [-a AUTH] [-o OUTPUT] page_id\n\n Dumps Confluence page in storage format\n\n positional arguments:\n page_id Configuration file\n\n optional arguments:\n -h, --help show this help message and exit\n -u URL, --url URL Confluence Url\n -a AUTH, --auth AUTH Base64 encoded user:password string\n -o OUTPUT, --output OUTPUT\n Output file|stdout|stderr\n\nConfiguration file format\n-------------------------\n\nDirectives:\n\n- **version** (required) Config version. Current is ``2``.\n- **url** (required) Base Confluence URL.\n- **base\\_dir** (required) Directory containing json to be published.\n- **downloads\\_dir** (optional) Default is \\_downloads\n- **images\\_dir** (optional) Default is \\_images\n- **source\\_ext** (optional) Default is .fjson\n- **pages** (required) Pages to be published.\n\n - **id** (required) Confluence page ID. If page does not exists,\n create it with ``conf_page_maker``.\n - **title** (optional)\n - **source** (required) Path to json associated with the page\n - **link** (optional) Link under watermark (for example to source\n rst in repo).\n - **watermark** (optional) Watermark to put on page. E.g.:\n \"Automatically generated content. Do not edit directly\"\".\n - **attachments** (optional) Files to be attached.\n\n - **images**\n\n - path\\_to\\_img1\n - path\\_to\\_img2\n\n - **downloads**\n\n - path\\_to\\_file1\n - path\\_to\\_file2\n\n - **pages** Subpages to be published.\n\n - **...** same structure as for pages\n\nConfig example\n~~~~~~~~~~~~~~\n\n::\n\n version: 2\n url: https://confluence.atlassian.com\n base_dir: docs/build/json\n pages:\n - attachments:\n downloads:\n - check_required_keywords.sh\n id: 49807825\n source: part_1/newcomers\n watermark: Automatic Publish\n link: https://github.com/pet-project/doc.rst\n - id: 49807842\n pages:\n - id: 49807843\n source: part_1/development/start\n - id: 49807844\n source: part_1/development/structure\n - id: 49807845\n source: part_1/development/documentation\n - id: 49807846\n source: part_1/development/logs\n source: part_1/development/index\n - attachments:\n downloads:\n - release.sh\n id: 49807847\n source: part_1/release\n - id: 49807848\n source: part_1/deployment\n - id: 49807849\n source: part_1/tools\n - id: 49807850\n source: part_1/plans\n - attachments:\n images:\n - 38-aval_1.jpg\n - 38-aval_2.jpg\n id: 49807851\n source: part_2/availability\n\nor more JSONify style:\n\n::\n\n {\n version: 2,\n base_dir: \"result\",\n pages: [\n {\n id: 52136662,\n source: \"release_history\"\n }\n ]\n }\n\n.. |Build Status| image:: https://travis-ci.org/Arello-Mobile/confluence-publisher.svg?branch=master\n :target: https://travis-ci.org/Arello-Mobile/confluence-publisher", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Arello-Mobile/confluence-publisher", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "confluence-publisher", "package_url": "https://pypi.org/project/confluence-publisher/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/confluence-publisher/", "project_urls": { "Homepage": "https://github.com/Arello-Mobile/confluence-publisher" }, "release_url": "https://pypi.org/project/confluence-publisher/1.2.1/", "requires_dist": [ "argparse (>=1.2.1)", "PyYAML (>=3.11)", "requests (>=2.4.3)" ], "requires_python": "", "summary": "Tool for publishing Sphinx generated documents to Confluence", "version": "1.2.1" }, "last_serial": 2343976, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "eb8109f8378e21f821c97d864faf0c55", "sha256": "c21dd02813dc9a108809db923f29d756dd155ac61fe0581a3505709ed94468f4" }, "downloads": -1, "filename": "confluence-publisher-1.0.0.tar.gz", "has_sig": false, "md5_digest": "eb8109f8378e21f821c97d864faf0c55", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9351, "upload_time": "2015-11-12T08:45:07", "url": "https://files.pythonhosted.org/packages/f9/1c/b4570d7476cb88756a04ad95318b6cef70cea27f84fef7bfca6dc0168ea8/confluence-publisher-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "172b104314f0141061869751df5e84ba", "sha256": "69ac498b798f60a3a7c8a6ebc7922f8cc41e3c2e0115f07bf663ca86cb4d863b" }, "downloads": -1, "filename": "confluence-publisher-1.1.0.tar.gz", "has_sig": false, "md5_digest": "172b104314f0141061869751df5e84ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12819, "upload_time": "2016-01-27T11:54:39", "url": "https://files.pythonhosted.org/packages/83/c1/770a67762e8f6e9b4b2a38b0e744b2bc8d38a5896bd70daf41aa235e1578/confluence-publisher-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "3d9680211fa6334dfa8a59e84797de2e", "sha256": "c3ad75aa4c094c78690df89aff4574989add78b8fc1f4d32fdb08a25004d46a5" }, "downloads": -1, "filename": "confluence-publisher-1.2.0.tar.gz", "has_sig": false, "md5_digest": "3d9680211fa6334dfa8a59e84797de2e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14071, "upload_time": "2016-06-07T06:12:31", "url": "https://files.pythonhosted.org/packages/b9/a5/952735bf88b2ca372046a3397ca71de3f1f14c34e3c0a4548c6a54658ab9/confluence-publisher-1.2.0.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "71160e56d09d11279456161fc8ffbdaf", "sha256": "5978721c7f25b86c7beff69ba18b6de2c1cb292bd3441cbd9becd955412b1915" }, "downloads": -1, "filename": "confluence_publisher-1.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "71160e56d09d11279456161fc8ffbdaf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 21382, "upload_time": "2016-09-15T10:50:51", "url": "https://files.pythonhosted.org/packages/eb/46/dfac97e381d9c96fdfa378b823850e35c24386761517102db9ae1a491bbf/confluence_publisher-1.2.1-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "71160e56d09d11279456161fc8ffbdaf", "sha256": "5978721c7f25b86c7beff69ba18b6de2c1cb292bd3441cbd9becd955412b1915" }, "downloads": -1, "filename": "confluence_publisher-1.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "71160e56d09d11279456161fc8ffbdaf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 21382, "upload_time": "2016-09-15T10:50:51", "url": "https://files.pythonhosted.org/packages/eb/46/dfac97e381d9c96fdfa378b823850e35c24386761517102db9ae1a491bbf/confluence_publisher-1.2.1-py2.py3-none-any.whl" } ] }