library/chapisha
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Python-based docx to standards-compliant epub3 conversion
69 commits 1 branch 1 tag 6.6 MiB
  • Python 81.2%
  • CSS 12%
  • HTML 6.8%
Find a file
Exact
Gavin Chait b8a3dabd78 Point project links at the new forge
2026-10-31 22:18:44 +01:00
.github/workflows Update python-app.yml 2024-05-23 17:26:54 +02:00
chapisha Point project links at the new forge 2026-10-31 22:18:44 +01:00
docs Point project links at the new forge 2026-10-31 22:18:44 +01:00
tests Update to version 0.6.0 2024-05-23 15:46:27 +02:00
.flake8 Complete refactor and update 2024-05-22 15:37:18 +02:00
.gitattributes Complete refactor and update 2024-05-22 15:37:18 +02:00
.gitignore Initial commit 2021-01-28 22:24:35 +01:00
.python-version Complete refactor and update 2024-05-22 15:37:18 +02:00
.readthedocs.yml Updated MKDocs documentation 2024-05-22 15:39:02 +02:00
CHANGELOG Dependency updates. 2021-11-21 14:31:17 +01:00
docs-requirements.txt Updated MKDocs documentation 2024-05-22 15:39:02 +02:00
LICENSE Initial commit 2021-01-28 22:24:35 +01:00
mkdocs.yml Point project links at the new forge 2026-10-31 22:18:44 +01:00
poetry.lock Complete refactor and update 2024-05-22 15:37:18 +02:00
pyproject.toml Point project links at the new forge 2026-10-31 22:18:44 +01:00
README.md Point project links at the new forge 2026-10-31 22:18:44 +01:00

README.md

Chapisha: docx to standards-compliant epub3 conversion

Documentation Status

What is it?

Chapisha (/ʧæpiʃɑ/) provides an intuitive method for converting a well-formatted Microsoft Word .docx file into a standards-compliant EPUB3 ebook.

There are only a small number of steps required to create your .epub, and Chapisha will provide an appropriate stylesheet and take care of document structure:

  • Set the working directory where you want to create your .epub,
  • Define and validate the metadata required for the creative work,
  • Import the docx file,
  • Import the cover image,
  • Define and add any contributors, such as cover artist,
  • Define your creative work's publication rights,
  • Add in an optional dedication,
  • Build your creative work as an EPUB3 standards-compliant ebook.

Read the docs

Why use it?

Chapisha is easy-to-use, quick, and fits into your workflow.

There are a multitude of .epub conversion tools but few that support the day-to-day workflow and tools used by most jobbing writers: Microsoft Word.

Chapisha draws on Pandoc for document conversion and ebook creation, adding a simple, stateless Python frame around it, which means you can also include it in a web application.

Installation and dependencies

You'll need at least Python 3.12, then:

pip install chapisha

You will also need to install Pandoc and Java:

sudo apt-get update
sudo apt-get -y install python3-dev libevent-dev pandoc default-jre

Changelog

The version history can be found in the changelog.

Background

Chapisha was created to serve my needs as both a formally, and self-published, author. I have written two novels - Lament for the fallen and Our memory like dust - and a number of short stories. These works are available to read online, and to download as an ebook.

Chapisha is the Swahili word for 'publish' or 'post'.

Licence

BSD 3

Other licenced elements: