{"id":13595404,"url":"https://github.com/anqxyr/mkepub","last_synced_at":"2026-04-09T03:33:45.366Z","repository":{"id":41081538,"uuid":"72469250","full_name":"anqxyr/mkepub","owner":"anqxyr","description":"Simple minimalistic library for creating EPUB3 files","archived":false,"fork":false,"pushed_at":"2026-01-17T18:27:00.000Z","size":219,"stargazers_count":77,"open_issues_count":0,"forks_count":18,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-01-18T01:04:51.819Z","etag":null,"topics":["epub","epub-files","epub-generation","minimalist-library"],"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/anqxyr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-10-31T19:08:01.000Z","updated_at":"2026-01-17T18:27:04.000Z","dependencies_parsed_at":"2024-01-29T05:51:34.897Z","dependency_job_id":"1fa9d57b-ab9f-477d-9371-e1271cb35f5b","html_url":"https://github.com/anqxyr/mkepub","commit_stats":{"total_commits":45,"total_committers":5,"mean_commits":9.0,"dds":"0.19999999999999996","last_synced_commit":"e64760113fcf508b0a238d0f71c2bd9a87de6d92"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/anqxyr/mkepub","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anqxyr%2Fmkepub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anqxyr%2Fmkepub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anqxyr%2Fmkepub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anqxyr%2Fmkepub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anqxyr","download_url":"https://codeload.github.com/anqxyr/mkepub/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anqxyr%2Fmkepub/sbom","scorecard":{"id":197901,"data":{"date":"2025-08-11","repo":{"name":"github.com/anqxyr/mkepub","commit":"e64760113fcf508b0a238d0f71c2bd9a87de6d92"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":2,"reason":"Found 6/22 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.0 not signed: https://api.github.com/repos/anqxyr/mkepub/releases/4561106","Warn: release artifact v1.0 does not have provenance: https://api.github.com/repos/anqxyr/mkepub/releases/4561106"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 14 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T22:09:57.900Z","repository_id":41081538,"created_at":"2025-08-16T22:09:57.900Z","updated_at":"2025-08-16T22:09:57.900Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31584638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"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":["epub","epub-files","epub-generation","minimalist-library"],"created_at":"2024-08-01T16:01:49.430Z","updated_at":"2026-04-09T03:33:45.361Z","avatar_url":"https://github.com/anqxyr.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"[![Build](https://github.com/anqxyr/mkepub/actions/workflows/ci.yml/badge.svg)](https://github.com/anqxyr/mkepub/actions/workflows/ci.yml)\n[![Coverage Status](https://coveralls.io/repos/github/anqxyr/mkepub/badge.svg?branch=master)](https://coveralls.io/github/anqxyr/mkepub?branch=master)\n[![License](https://img.shields.io/github/license/anqxyr/mkepub.svg?maxAge=2592000)](https://github.com/anqxyr/mkepub/LICENSE)\n\n# mkepub\n\n**mkepub** is a minimalistic library for creating .epub files.\n\n**Pros:**\n\n* Easy to use, minimalistic API.\n* Automatically generated TOC.\n* Support for nested TOC of any depth.\n* Support for embedded images.\n* Support for embedded fonts.\n* In-progress books are stored on disk rather than in memory, enabling creation of large (5000+ pages, 20+ MiBs) epub files.\n* Adherence to the EPUB3 specs.\n* Support for most of the EPUB metadata, including language, subject, description, and rights.\n\n**Cons:**\n\n* No support for custom page filenames or directory structure.\n* No support for reading or editing epub files.\n* No content validation - using broken or unsupported html code as page content will lead to mkepub successfully creating a .epub file that does not meet EPUB3 specifications.\n* Probably other issues.\n\n\n### Basic Usage\n\n```python\nimport mkepub\n\nbook = mkepub.Book(title='An Example')\nbook.add_page(title='First Page', content='Lorem Ipsum etcetera.')\nbook.save('example.epub')\n```\n\n### Advanced Usage\n\n```python\nimport mkepub\n\nbook = mkepub.Book(title='Advanced Example', author='The Author')\n# multiple authors can be specified as a list:\n# mkepub.Book(title='Advanced Example', authors=['The First Author', 'The Second Author'])\nbook.set_cover_from_file('cover.jpg')\nbook.set_stylesheet_from_file('style.css')\n\nfirst = book.add_page('Chapter 1', 'And so the book begins.')\n\nchild = book.add_page('Chapter 1.1', 'Nested TOC is supported.', parent=first)\nbook.add_page('Chapter 1.1.1', 'Infinite nesting levels', parent=child)\nbook.add_page('Chapter 1.2', 'In any order you wish.', parent=first)\n\nbook.add_page('Chapter 2', 'Use \u003cb\u003ehtml\u003c/b\u003e to make your text \u003cspan class=\"pink\"\u003eprettier\u003c/span\u003e')\n\nbook.add_page('Chapter 3: Images', '\u003cimg src=\"images/chapter3.png\" alt=\"You can use images as well\"\u003e')\n# as long as you add them to the book:\nwith open('chapter3.png', 'rb') as file:\n    book.add_image('chapter3.png', file.read())\n\n# you can also add custom fonts to the book\nbook.add_font_from_file('your_font.woff')\n\nbook.save('advanced.epub')\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanqxyr%2Fmkepub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanqxyr%2Fmkepub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanqxyr%2Fmkepub/lists"}