https://github.com/wcember/pypub

Python library to programatically create epub files
https://github.com/wcember/pypub

Last synced: about 2 months ago
JSON representation

Python library to programatically create epub files

• Host: GitHub
• URL: https://github.com/wcember/pypub
• Owner: wcember
• License: mit
• Created: 2015-12-30T23:50:53.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-07-29T16:15:27.000Z (about 1 year ago)
• Last Synced: 2024-07-19T21:52:07.486Z (about 2 months ago)
• Language: HTML
• Size: 2.82 MB
• Stars: 273
• Watchers: 11
• Forks: 41
• Open Issues: 17
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - pypub - Python library to programatically create epub files (HTML)

README

        
# Pypub #

Create epub's using python. Pypub is a python library to create epub files quickly without having to worry about the intricacies of the epub specification.

# Installation #

The current release of pypub is available through pip:

    $ pip install pypub

Pypub is currently only compatible with Python 2.

# Quickstart #

```python

>>> import pypub

>>> my_first_epub = pypub.Epub('My First Epub')

>>> my_first_chapter = pypub.create_chapter_from_url('https://en.wikipedia.org/wiki/EPUB')

>>> my_first_epub.add_chapter(my_first_chapter)

>>> my_first_epub.create_epub('OUTPUT_DIRECTORY')

```

# Features #

* Pypub is **easy to install** and has minimal dependencies.

* Pypub **abstracts the epub specification**. Create epubs without worrying about what an NCX is.

* Pypub can **create epubs from websites, html files, strings**, or a combination of all three.

* Pypub can **clean up poorly formatted and complicated html** so it will cleanly as a chapter in your book.

* Pypub **creates epubs specifically so they can be converted into Amazon Kindle mobi or azw3 files**. Don't know which tags Amazon supports? Don't worry about it because pypub does. 

* Pypub is **customizable**. Don't like the way pypub sanitizes html files for you ebook? Pypub can be configured with your own sanitation function.

* Pypub is **licensed under the MIT license**. Do what you want with it.

# Documentation #

Documentation is available at [http://pypub.readthedocs.org/en/latest/developer_interface.html](http://pypub.readthedocs.org/en/latest/developer_interface.html)

# Copyright and License #

Copyright (c) 2020 William Cember

[**Licensed**](https://github.com/wcember/pypub/blob/master/LICENSE) under the MIT License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.