{"id":29976147,"url":"https://github.com/danishi/backlog-document-exporter","last_synced_at":"2025-08-13T15:43:57.978Z","repository":{"id":298895979,"uuid":"1001457382","full_name":"danishi/backlog-document-exporter","owner":"danishi","description":"Backlog Document Exporter","archived":false,"fork":false,"pushed_at":"2025-06-16T12:44:42.000Z","size":33,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-29T01:54:13.855Z","etag":null,"topics":["backlog","backlog-api","python"],"latest_commit_sha":null,"homepage":"","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/danishi.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"danishi","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2025-06-13T12:14:53.000Z","updated_at":"2025-06-16T12:44:42.000Z","dependencies_parsed_at":"2025-06-13T13:48:15.659Z","dependency_job_id":"1b143d92-8782-43c3-bd32-b17cdc5c17ac","html_url":"https://github.com/danishi/backlog-document-exporter","commit_stats":null,"previous_names":["danishi/backlog-document-exporter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/danishi/backlog-document-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danishi%2Fbacklog-document-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danishi%2Fbacklog-document-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danishi%2Fbacklog-document-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danishi%2Fbacklog-document-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danishi","download_url":"https://codeload.github.com/danishi/backlog-document-exporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danishi%2Fbacklog-document-exporter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268672132,"owners_count":24288244,"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","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["backlog","backlog-api","python"],"created_at":"2025-08-04T08:43:06.437Z","updated_at":"2025-08-04T08:43:07.331Z","avatar_url":"https://github.com/danishi.png","language":"Python","funding_links":["https://github.com/sponsors/danishi"],"categories":[],"sub_categories":[],"readme":"# Backlog Document Exporter\n\nBacklog Document Exporter is a small command line tool for exporting documents from Backlog. The program uses the Backlog Document API (beta) and prints information in Markdown format.\n\n## Configuration\n\nCreate a `.env` file based on `.env.example` and set the following values:\n\n```\nBACKLOG_SPACE_DOMAIN=your-space.backlog.com\nBACKLOG_API_KEY=your-api-key\nBACKLOG_PROJECT_KEY=PROJECTKEY\nBACKLOG_SSL_VERIFY=true\n```\n\nSet `BACKLOG_SSL_VERIFY` to `false` if you need to skip TLS certificate verification.\n\n## Setup\n\nInstall dependencies into a virtual environment:\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip3 install -r requirements.txt\n```\n\n## Usage\n\n```\npython3 -m backlog_document_exporter.cli list\npython3 -m backlog_document_exporter.cli tree\npython3 -m backlog_document_exporter.cli info \u003cdocument_id\u003e\npython3 -m backlog_document_exporter.cli download \u003cdocument_id\u003e [output_dir]\npython3 -m backlog_document_exporter.cli export [output_dir]\npython3 -m backlog_document_exporter.cli export-md [output_file]\n```\n\nIf `output_dir` is omitted, files are saved to the current directory.\n\nThe `list` command automatically fetches all pages using the required `offset` parameter. Each row in its output also contains a `url` column in the following format:\n\n```\nhttps://BACKLOG_SPACE_DOMAIN/document/BACKLOG_PROJECT_KEY/\u003cdocument_id\u003e\n```\n\nThe `tree` command prints a hierarchical view of the documents and appends the same URL after each document title.\n\n`\u003cdocument_id\u003e` is the identifier shown in the list or tree output. All command output other than downloaded files is printed in Markdown.\n\nThe `export` command downloads all documents in the current project, recreating the document tree as directories. Each document's metadata and content are saved to `document.md` alongside any attachments.\n\nThe `export-md` command writes the document tree followed by each document's title and content to a single Markdown file. If `output_file` is omitted, `documents.md` is created in the current directory.\n\n## Reference\n\n- [Backlog Document API update information](https://backlog.com/ja/blog/backlog-update-document-202506/#API%E3%82%92%E6%8B%A1%E5%85%85%E3%81%97%E3%81%BE%E3%81%97%E3%81%9F)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanishi%2Fbacklog-document-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanishi%2Fbacklog-document-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanishi%2Fbacklog-document-exporter/lists"}