{"id":18900024,"url":"https://github.com/likema/redmine-exporter","last_synced_at":"2025-04-15T02:36:09.235Z","repository":{"id":143436677,"uuid":"205287333","full_name":"likema/redmine-exporter","owner":"likema","description":"Redmine exporting tool","archived":false,"fork":false,"pushed_at":"2020-06-21T10:30:03.000Z","size":21,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T14:21:58.352Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/likema.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-30T02:14:53.000Z","updated_at":"2024-10-15T20:58:36.000Z","dependencies_parsed_at":"2023-06-06T18:45:20.521Z","dependency_job_id":null,"html_url":"https://github.com/likema/redmine-exporter","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/likema%2Fredmine-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likema%2Fredmine-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likema%2Fredmine-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likema%2Fredmine-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/likema","download_url":"https://codeload.github.com/likema/redmine-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248995024,"owners_count":21195486,"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":[],"created_at":"2024-11-08T08:48:47.840Z","updated_at":"2025-04-15T02:36:09.216Z","avatar_url":"https://github.com/likema.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Redmine exporting tool\n\n## Prerequisites\n\nFor simplicity, installing required packages on Ubuntu 20.04\n\n### Ubuntu 20.04\n\n```bash\nsudo apt-get install -y python3-redminelib python3-bs4 python3-lxml\n```\n\nOptionally, for converting SVG to other image format by ImageMagick `convert` :\n\n```bash\nsudo apt-get install -y imagemagick\n```\n\nOptionally, for exporting beautiful PDF by [WeasyPrint](https://weasyprint.org/):\n\n```bash\nsudo apt-get install -y weasyprint\n```\n\nOptionally, for exporting as [DocBook](https://docbook.org/):\n\n```bash\nsudo apt-get install -y pandoc\n```\n\n### Other Platforms\n\n* Python 3\n    ```bash\n    pip install python-redmine beautifulsoup4 lxml\n    ```\n* Optionally, for converting SVG to other image format [by ImageMagick](https://imagemagick.org/) `convert` :\n* Optionally, for exporting beautiful PDF by install [WeasyPrint](https://weasyprint.org/)\n* Optionally, for exporting as [DocBook](https://docbook.org/), install [Pandoc](https://pandoc.org/installing).\n\n## Usage\n\n```\nusage: redmine-exporter [-h] [-t {textile,html,pdf,docbook}] [-u REDMINE_URL]\n                        [-k REDMINE_KEY] [-p PROJECT] [--css CSS]\n                        [--embed-images] [--convert-svg {png,jpg,gif}]\n                        [--convert-svg-opts CONVERT_SVG_OPTS] [--toc]\n                        [-f FILE] [-o OUTPUT] [--title TITLE]\n                        [--docbook-tpl DOCBOOK_TPL] [--pandoc PANDOC]\n                        [--weasyprint [WEASYPRINT]]\n                        wiki [wiki ...]\n\npositional arguments:\n  wiki                  wiki name\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -t {textile,html,pdf,docbook}, --type {textile,html,pdf,docbook}\n                        Export format type\n  -u REDMINE_URL, --redmine-url REDMINE_URL\n                        Remine access key\n  -k REDMINE_KEY, --redmine-key REDMINE_KEY\n                        Remine access key\n  -p PROJECT, --project PROJECT\n                        Remine project id or name\n  --css CSS             Replace html style tag by css file.\n  --embed-images        Base64 encode images into html.\n  --convert-svg {png,jpg,gif}\n                        Convert SVG to other image format by ImageMagick\n                        convert.\n  --convert-svg-opts CONVERT_SVG_OPTS\n                        ImageMagick convert command line options\n  --toc                 Enable html or wiki table of content\n  -f FILE, --file FILE  Specify configure, default ~/.redmine_exporter.conf\n  -o OUTPUT, --output OUTPUT\n                        Output directory\n  --title TITLE         Specify title\n  --docbook-tpl DOCBOOK_TPL\n                        Specify docbook template\n  --pandoc PANDOC       pandoc cli options for generating docbook\n  --weasyprint [WEASYPRINT]\n                        weasyprint cli options for generating pdf\n```\n\nFor simplicity, you can write `~/.redmine\\_exporter.conf` as\n\n```json\n{\n\t\"redmine_url\": \"\u003credmine url\u003e\",\n\t\"redmine_key\": \"\u003cyour redmine key\u003e\",\n\t\"project\": \"\u003cdefault redmine project\u003e\",\n    \"css\": \"\u003cdefault css full path\u003e\",\n    \"convert_svg_opts\": \"-antialias -font Noto-Sans-CJK-SC-Thin -background none\"\n}\n```\n\nThe following options can be set in `~/.redmine\\_exporter.conf`:\n\n* `redmine_url`: identical to `--redmine-url` and env `REDMINE_URL`\n* `redmine_key`: identical to `--redmine-key` and env `REDMINE_KEY`\n* `project`: identical to `--project` and env `REDMINE_PROJECT`\n* `css`: identical to `--css` and env `REDMINE_CSS`\n* `docbook_tpl`: identical to `--docbook-tpl` and `REDMINE_DOCKBOOK_TPL`\n* `convert_svg_opts`: identical to `--convert-svg-opts`\n\n### Export Textile\n\n\n```bash\n./redmine_exporter -t textile \"\u003cwiki\u003e\"\n```\n\n### Export HTML with CSS\n\n\n```bash\n./redmine_exporter -t html --css default.css \"\u003cwiki\u003e\"\n```\n\n### Export HTML and convert it to PDF by WeasyPrint\n\n```bash\n./redmine_exporter -t pdf --weasyprint --css default.css \"\u003cwiki\u003e\"\n```\n\nIt is better than exporting PDF directly.\n\n### Export DocBook with new title\n\n```bash\n./redmine_exporter -t docbook --title \"\u003cnew title\u003e\" \"\u003cwiki\u003e\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flikema%2Fredmine-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flikema%2Fredmine-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flikema%2Fredmine-exporter/lists"}