{"id":21927959,"url":"https://github.com/mam-dev/confluencer","last_synced_at":"2025-04-19T17:34:11.197Z","repository":{"id":62564421,"uuid":"41909483","full_name":"mam-dev/confluencer","owner":"mam-dev","description":":wrench: :scroll: A CLI tool to automate common Confluence maintenance tasks and content publishing.","archived":false,"fork":false,"pushed_at":"2020-06-10T09:08:56.000Z","size":159,"stargazers_count":20,"open_issues_count":21,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T10:51:18.009Z","etag":null,"topics":["automation","cli","cli-utilities","confluence","migration","python","rest-api","wiki"],"latest_commit_sha":null,"homepage":"https://confluencer.readthedocs.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mam-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-04T10:09:43.000Z","updated_at":"2024-01-05T23:25:32.000Z","dependencies_parsed_at":"2022-11-03T16:00:41.152Z","dependency_job_id":null,"html_url":"https://github.com/mam-dev/confluencer","commit_stats":null,"previous_names":["1and1/confluencer"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mam-dev%2Fconfluencer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mam-dev%2Fconfluencer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mam-dev%2Fconfluencer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mam-dev%2Fconfluencer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mam-dev","download_url":"https://codeload.github.com/mam-dev/confluencer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249750199,"owners_count":21320095,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cli","cli-utilities","confluence","migration","python","rest-api","wiki"],"created_at":"2024-11-28T22:19:31.939Z","updated_at":"2025-04-19T17:34:11.165Z","avatar_url":"https://github.com/mam-dev.png","language":"Python","readme":"# confluencer\n\nA CLI tool to automate common Confluence maintenance tasks and content publishing.\n\n [![Travis CI](https://api.travis-ci.org/1and1/confluencer.svg)](https://travis-ci.org/1and1/confluencer)\n [![Coveralls](https://img.shields.io/coveralls/1and1/confluencer.svg)](https://coveralls.io/r/1and1/confluencer)\n [![GitHub Issues](https://img.shields.io/github/issues/1and1/confluencer.svg)](https://github.com/1and1/confluencer/issues)\n [![License](https://img.shields.io/pypi/l/confluencer.svg)](https://github.com/1and1/confluencer/blob/master/LICENSE)\n [![Latest Version](https://img.shields.io/pypi/v/confluencer.svg)](https://pypi.python.org/pypi/confluencer/)\n [![Downloads](https://img.shields.io/pypi/dw/confluencer.svg)](https://pypi.python.org/pypi/confluencer/)\n\n\n## Overview\n\nThe ``confluencer`` command line tool (or ``cfr`` for short) allows you to\ncontrol your Confluence installation from a shell prompt, and thus automate\n(mass) content changes and reports.\n\nFor example, ``cfr tidy`` applies rules to remove artifacts from a page's body\nleft behind if you cut\u0026copy content from other sources (especially *FosWiki* pages).\n\nThe ``confluencer.api`` Python package can be used in your own scripts to implement\nmore complex custom use-cases that are not covered by the provided commands.\nIt provides helpers like converting an URL as found in the web interface (i.e.\nyour browser's location bar) into an API one, and abstractions for typical\n*Confluence* objects like pages and spaces.\n\n\n## Installation\n\n*Confluencer* can be installed via ``pip install confluencer`` as usual,\nsee [releases](https://github.com/1and1/confluencer/releases) for an overview of available versions.\nTo get a bleeding-edge version from source, use these commands:\n\n```sh\nrepo=\"1and1/confluencer\"\npip install -r \"https://raw.githubusercontent.com/$repo/master/requirements.txt\"\npip install -U -e \"git+https://github.com/$repo.git#egg=${repo#*/}\"\n```\n\nSee [Contributing](#contributing) on how to create a full development environment.\n\nTo add bash completion, read the [Click docs](http://click.pocoo.org/4/bashcomplete/#activation) about it,\nor just follow these instructions:\n\n```sh\ncmdname=confluencer\nmkdir -p ~/.bash_completion.d\n( export _$(tr a-z- A-Z_ \u003c\u003c\u003c\"$cmdname\")_COMPLETE=source ; \\\n  $cmdname \u003e~/.bash_completion.d/$cmdname.sh )\ngrep /.bash_completion.d/$cmdname.sh ~/.bash_completion \u003e/dev/null \\\n    || echo \u003e\u003e~/.bash_completion \". ~/.bash_completion.d/$cmdname.sh\"\n. \"/etc/bash_completion\"\n```\n\n\n## Usage\n\nSee the [main documentation](http://confluencer.readthedocs.io/) at *Read the Docs*.\n\n\n## Contributing\n\nContributing to this project is easy, and reporting an issue or\nadding to the documentation also improves things for every user.\nYou don’t need to be a developer to contribute.\nSee [CONTRIBUTING](https://github.com/1and1/confluencer/blob/master/CONTRIBUTING.md) for more.\n\nAs a documentation author or developer,\nto create a working directory for this project,\ncall these commands:\n\n```sh\ngit clone \"https://github.com/1and1/confluencer.git\"\ncd \"confluencer\"\n. .env --yes --develop\ninvoke build --docs test check\n```\n\nYou might also need to follow some\n[setup procedures](https://py-generic-project.readthedocs.io/en/latest/installing.html#quick-setup)\nto make the necessary basic commands available on *Linux*, *Mac OS X*, and *Windows*.\n\n\n## References\n\n**Tools**\n\n* [Cookiecutter](http://cookiecutter.readthedocs.io/en/latest/)\n* [PyInvoke](http://www.pyinvoke.org/)\n* [pytest](http://pytest.org/latest/contents.html)\n* [tox](https://tox.readthedocs.io/en/latest/)\n* [Pylint](http://docs.pylint.org/)\n* [twine](https://github.com/pypa/twine#twine)\n* [bpython](http://docs.bpython-interpreter.org/)\n* [yolk3k](https://github.com/myint/yolk#yolk)\n\n**Packages**\n\n* [Rituals](https://jhermann.github.io/rituals)\n* [Click](http://click.pocoo.org/)\n\n\n## Related Projects\n\n* [Conflence.py](https://github.com/RaymiiOrg/confluence-python-cli) – A 1:1 mapping of the REST API to a command line tool.\n* [PythonConfluenceAPI](https://github.com/pushrodtechnology/PythonConfluenceAPI) - A Pythonic API wrapper over the Confluence REST API.\n* [pyconfluence](https://github.com/FulcrumIT/pyconfluence) – PyConfluence is designed for automated documentation, with convenience in mind and easy interaction with the numerous services Confluence offers.\n* [rst2confluence](https://github.com/netresearch/rst2confluence) – Convert reStructuredText to Confluence style wiki markup.\n\n\n## Acknowledgements\n\n…\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmam-dev%2Fconfluencer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmam-dev%2Fconfluencer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmam-dev%2Fconfluencer/lists"}