{"id":21417953,"url":"https://github.com/msg-systems/confluence-uploader","last_synced_at":"2025-08-22T01:14:25.792Z","repository":{"id":59734082,"uuid":"537318116","full_name":"msg-systems/confluence-uploader","owner":"msg-systems","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-20T06:02:11.000Z","size":56,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-15T23:57:11.205Z","etag":null,"topics":["automation","confluence","csv","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/msg-systems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-16T05:30:52.000Z","updated_at":"2023-08-03T07:16:56.000Z","dependencies_parsed_at":"2022-09-21T02:32:41.636Z","dependency_job_id":null,"html_url":"https://github.com/msg-systems/confluence-uploader","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2Fconfluence-uploader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2Fconfluence-uploader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2Fconfluence-uploader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msg-systems%2Fconfluence-uploader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/msg-systems","download_url":"https://codeload.github.com/msg-systems/confluence-uploader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243918629,"owners_count":20368745,"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","confluence","csv","python"],"created_at":"2024-11-22T19:18:19.339Z","updated_at":"2025-03-16T19:21:23.516Z","avatar_url":"https://github.com/msg-systems.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Confluence Uploader\n\nTemplate-based, CSV feeded mass-creation for and upload of articles to Confluence. \n\n## Installation\n\n**Important:** Run the scripts provided in `scripts` from that directory.\n\n### Installing Python\nPython 3.10 is required. Here is a manual for [installing Python](https://realpython.com/installing-python/) on different operating systems. Additionally, the package manager `pip` is needed. Usually, it is already provided with a standard installation, but in case it is not, you need to install it [manually](https://pypi.org/project/pip/).\n\nDepending on your operating system and file association configuration, the `python` command may be `python3` and `pip` may be `pip3`.\n\n### Installing the required modules\n\nYou can install the required modules in multiple ways:\n* On Windows, run `scripts/install.bat`\n* On Linux, run `scripts/install.sh`\n* Alternatively, install the required modules listed in `requirements.txt` via `pip install -r requirements.txt`\n* ... or manually\n\nIt it recommended to generate an API token on Confluence, which, together with an username, then can be used for authentication with this program.\n\n### Starting the program\n\n* Run `python start.py` in the root directory.\n* Alternatively, use `scripts/run.bat` or `scripts/run.sh`.\n\n### Minimal configuration\n\nThe configuration properties in `config/config.ini` and `config/uploader_config.ini` contain explanatory comments. Consult those in case you're not sure about the meaning of specific configuration properties.\n\n#### GUI Mode\n\nIf you're using the default configuration, you will configure the program via a GUI. This GUI will show you which properties are required.\n\n#### Console Mode\n\nIf you're not using the GUI (set `user_gui` in `config/config.ini` to `false`), then you have to configure the program manually via `config/uploader_config.ini`.\nThe following properties have to be specified:\n* `base_url`\n* `template_id`\n* `upload_space`\n* and `data_csv`.\nThe other properties use default values.\n\n### Documentation\n\n* A short manual and an error catalog can be found at [./docs/manual.md](./docs/manual.md). Most errors in the program are logged with an error ID, which you can lookup in the error catalog for an explanation.\n* Contact the author via `florian-f.haas@msg.group` if questions not covered by existing documentation arise.\n\n### Dev installation\n\n* If you want to run the supplied unit tests, you need the additional requirements specified in `test/requirements-test.txt`. You can install them via `pip install -r requirements.txt`.\n* Alternatively, install them via `scripts/install-dev.bat` or `scripts/install-dev.sh`.\n\n### Testing\n\n* Modules excluded from test coverage measurement are `logger.py`, `gui.py`, `start.py` and `constants.py`, as well as everything in the `./test/` folder.\n* `# pragma: no cover` comments tell the coverage tool to ignore the marked statement/body.\n* You can run the tests manually or via `run-tests.bat`/`run-tests.sh` in `scripts`.\n\n## LICENSE\n\nMIT License\n\nCopyright (c) 2022 msg systems ag\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsg-systems%2Fconfluence-uploader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsg-systems%2Fconfluence-uploader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsg-systems%2Fconfluence-uploader/lists"}