# Chapisha: docx to standards-compliant epub3 conversion
[](https://chapisha.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/whythawk/chapisha/actions)
## 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](https://chapisha.readthedocs.io/en/latest/)
## 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](https://pandoc.org/epub.html) 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](https://github.com/whythawk/chapisha/blob/master/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](https://gavinchait.com/lament-for-the-fallen/) and
[Our memory like dust](https://gavinchait.com/our-memory-like-dust/) - and a number of
[short stories](https://gavinchait.com/). These works are available to read online, and to download
as an ebook.
[Chapisha](https://glosbe.com/sw/en/-chapisha) is the *Swahili* word for 'publish' or 'post'.
## Licence
[BSD 3](LICENSE)
Other licenced elements:
- [Samara logo](chapisha/helpers/images/logo.png) is copyright [Whythawk](https://whythawk.com) and [Qwyre](https://gavinchait.com).
- [Cover photo](tests/data/cover.jpg) is copyright Rodd Halstead, licenced under commercial terms to Whythawk, and used here for test purposes.
- [Usan Abasi's Lament](https://gavinchait.com/usan-abasis-lament/) is copyright Gavin Chait, licenced [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) and used here for test purposes.
Raw data
{
"_id": null,
"home_page": "https://github.com/whythawk/chapisha",
"name": "chapisha",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "python3, epub-generation, epub3, docx-to-epub",
"author": "Gavin Chait",
"author_email": "gchait@whythawk.com",
"download_url": "https://files.pythonhosted.org/packages/be/d7/eb28eb89b5c21966f6fcdb629243fcc764be8d2554aca6f955f48c52b65e/chapisha-0.6.0.tar.gz",
"platform": null,
"description": "# Chapisha: docx to standards-compliant epub3 conversion\n\n[](https://chapisha.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/whythawk/chapisha/actions)\n\n## What is it?\n\n**Chapisha** (/\u02a7\u00e6pi\u0283\u0251/) provides an intuitive method for converting a well-formatted Microsoft Word `.docx` file into a \nstandards-compliant EPUB3 ebook.\n\nThere are only a small number of steps required to create your `.epub`, and **Chapisha** will provide an appropriate\nstylesheet and take care of document structure:\n\n- Set the working directory where you want to create your `.epub`,\n- Define and validate the metadata required for the creative work,\n- Import the `docx` file,\n- Import the cover image,\n- Define and add any contributors, such as cover artist,\n- Define your creative work's publication rights,\n- Add in an optional dedication,\n- Build your creative work as an EPUB3 standards-compliant ebook.\n\n[Read the docs](https://chapisha.readthedocs.io/en/latest/)\n\n## Why use it?\n\n**Chapisha** is easy-to-use, quick, and fits into your workflow.\n\nThere are a multitude of `.epub` conversion tools but few that support the day-to-day workflow and tools used by most\njobbing writers: Microsoft Word.\n\n**Chapisha** draws on [Pandoc](https://pandoc.org/epub.html) for document conversion and ebook creation, adding a \nsimple, stateless Python frame around it, which means you can also include it in a web application.\n\n## Installation and dependencies\n\nYou'll need at least Python 3.12, then:\n\n pip install chapisha\n\nYou will also need to install `Pandoc` and `Java`:\n\n sudo apt-get update\n sudo apt-get -y install python3-dev libevent-dev pandoc default-jre\n\n## Changelog\n\nThe version history can be found in the [changelog](https://github.com/whythawk/chapisha/blob/master/CHANGELOG).\n\n## Background\n\n**Chapisha** was created to serve my needs as both a formally, and self-published, author. I have written two \nnovels - [Lament for the fallen](https://gavinchait.com/lament-for-the-fallen/) and \n[Our memory like dust](https://gavinchait.com/our-memory-like-dust/) - and a number of \n[short stories](https://gavinchait.com/). These works are available to read online, and to download\nas an ebook.\n\n[Chapisha](https://glosbe.com/sw/en/-chapisha) is the *Swahili* word for 'publish' or 'post'.\n\n## Licence\n[BSD 3](LICENSE)\n\nOther licenced elements:\n\n- [Samara logo](chapisha/helpers/images/logo.png) is copyright [Whythawk](https://whythawk.com) and [Qwyre](https://gavinchait.com).\n- [Cover photo](tests/data/cover.jpg) is copyright Rodd Halstead, licenced under commercial terms to Whythawk, and used here for test purposes.\n- [Usan Abasi's Lament](https://gavinchait.com/usan-abasis-lament/) is copyright Gavin Chait, licenced [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) and used here for test purposes.",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Chapisha: docx to standards-compliant epub3 conversion",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://chapisha.readthedocs.io/",
"Homepage": "https://github.com/whythawk/chapisha",
"Repository": "https://github.com/whythawk/chapisha"
},
"split_keywords": [
"python3",
" epub-generation",
" epub3",
" docx-to-epub"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4018af28b48add61498ade33f827e49ad0868746a0d3630e3dcc26a98141e7b1",
"md5": "b3a7a0867963f8efbae35efdb4f6bc55",
"sha256": "fa2870eb756f2431212738f10241e1f9d64230f58a827a1f6d41ef8778ed766b"
},
"downloads": -1,
"filename": "chapisha-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3a7a0867963f8efbae35efdb4f6bc55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 2365106,
"upload_time": "2024-05-23T13:47:53",
"upload_time_iso_8601": "2024-05-23T13:47:53.875578Z",
"url": "https://files.pythonhosted.org/packages/40/18/af28b48add61498ade33f827e49ad0868746a0d3630e3dcc26a98141e7b1/chapisha-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bed7eb28eb89b5c21966f6fcdb629243fcc764be8d2554aca6f955f48c52b65e",
"md5": "099f580a3a962e512b99704bb85fe74e",
"sha256": "7a1a7fe4a538cb8f667e361a2dec2de2d9410c118693422437d4b380ac9d9827"
},
"downloads": -1,
"filename": "chapisha-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "099f580a3a962e512b99704bb85fe74e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 2352741,
"upload_time": "2024-05-23T13:47:56",
"upload_time_iso_8601": "2024-05-23T13:47:56.751094Z",
"url": "https://files.pythonhosted.org/packages/be/d7/eb28eb89b5c21966f6fcdb629243fcc764be8d2554aca6f955f48c52b65e/chapisha-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-23 13:47:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whythawk",
"github_project": "chapisha",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chapisha"
}
JSON
