wcember · imgurbot12 · Jun 21, 2020 · Jun 21, 2020 · Jun 21, 2020 · Jun 21, 2020
diff --git a/MANIFEST b/MANIFEST
diff --git a/Readme.md → README.md b/Readme.md → README.md
@@ -2,21 +2,24 @@
 
 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.
 
+This package was orignally forked and re-writen based on WCember's [python2 version](https://github.com/wcember/pypub)
+but due to lack of any response has been re-released as a new package to support python3
+
 # Installation #
 The current release of pypub is available through pip:
 
-    $ pip install pypub
+    $ pip install pypub3
 
-Pypub is currently only compatible with Python 2.
+Pypub is only compatible with Python <= 3.6.
 
 # 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')
+```python3
+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 #
@@ -34,8 +37,8 @@ Documentation is available at [http://pypub.readthedocs.org/en/latest/developer_
 
 # Copyright and License #
 
-Copyright (c) 2020 William Cember
+Copyright (c) 2022 Andrew Scott
 
-[**Licensed**](https://github.com/wcember/pypub/blob/master/LICENSE) under the MIT License
+[**Licensed**](https://github.com/imgurbot12/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.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,6 +19,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -32,7 +33,9 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.coverage',
-    'sphinxcontrib.napoleon',]
+    'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/source/developer_interface.rst b/docs/source/developer_interface.rst
@@ -4,7 +4,9 @@ Developer Interface
 Functions
 =========================
 
-.. autofunction:: pypub.clean
+.. autofunction:: pypub.create_chapter_from_string
+.. autofunction:: pypub.create_chapter_from_file
+.. autofunction:: pypub.create_chapter_from_url
 
 Classes
 =========================
@@ -13,7 +15,3 @@ Classes
    :members: add_chapter, create_epub
 
 .. autoclass:: pypub.Chapter
-   :members: write
-
-.. autoclass:: pypub.ChapterFactory
-   :members: create_chapter_from_url, create_chapter_from_file, create_chapter_from_string
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,6 @@
 
 pypub: Create epub files easily with python
-==================================
+============================================
 
 Contents:
 
@@ -19,4 +19,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/docs/source/tutorial_reddit.rst b/docs/source/tutorial_reddit.rst
@@ -1,11 +1,11 @@
 Tutorial - create an epub from reddit stories
-**********
+*****************
 
 Ready to get started? In this tutorial we will create an epub from the top stories currently on reddit.
 
 Before you start, make sure the following is true
 
-- Confirm that python 2 is installed on your machine and that you are using is. As of this writing, pypub is not compatible with python 3.
+- Confirm that python 3 is installed on your machine and that you are using is.
 - Make sure the most recent version of `pypub <http://pypub.readthedocs.io/en/latest/pypub.html#installation>`_ is installed
 - In this tutorial, we are going to use the python package `praw <https://praw.readthedocs.io/en/stable/#installation>`_ to access reddit's api. Download that too. While praw is necessary for this tutorial, you do not need it to use pypub.
 - (Optional) If you want to read your ebook on kindle, you'll need to convert it to a mobi file. Download `KindleGen <http://www.amazon.com/gp/feature.html?docId=1000765211>`_ to do this.
@@ -19,7 +19,7 @@ Let's begin by importing pypub as well as the other python libraries we're using
 
     >>> import pypub
     >>> import praw, os
- 
+
 Now let's get the current top ten stories from r/TrueReddit. The below code is necessary for this tutorial, but all we're returning here is a list of urls of stories we are interested in. Feel free to substitute here code to get whatever you are interested in (posts from your favorite blog, magazine articles, etc.)
 
     >>> praw_object = praw.Reddit(user_agent='pypub/1.0')
@@ -32,7 +32,7 @@ top_submission_url_list is a python list of strings, where each string represent
 Create the epub
 ****************
 Now that we have a list of url strings, we can use pypub to download the content and create an epub from the stories. First let's create an Epub object called epub. The only information we need to provide is the title of the ebook we'll be creating, which we will call 'TrueReddit - Top Stories'.
-    
+
     >>> epub = pypub.Epub('TrueReddit - Top Stories')
 
 With the Epub object we just created, let's add a chapter to it for every story we in our url list.
@@ -45,7 +45,7 @@ With the Epub object we just created, let's add a chapter to it for every story
     ...         pass
 
 Note in the above code that we try to create a chapter from every url, but don't if pypub raises a ValueError, which occurs if you try using pypub without an internet connection or if the url is invalid.
-   
+
 Finally, let's create our epub file. The below code saves it in the current working directory, but feel free to change that.
 
     >>> epub.create_epub(os.getcwd())
@@ -60,7 +60,7 @@ If you're like me, then you like reading things on your kindle (which is why I c
 Luckily, Amazon provided a tool, KindleGen to convert epubs (and other formats) to mobi so they can be viewed on kindle. Once it's downloaded, convert *TrueReddit - Top Stories.epub* by going to the command prompt and entering kindlegen's full file path (excluding .exe) followed by "TrueReddit - Top Stories.epub".
 
     > <full directory of kindlegen>kindlegen "TrueReddit - Top Stories.epub"
-    
+
 If the kindlegen executable is saved in the same directory as *TrueReddit - Top Stories.epub*, this can simply be entered as
 
     > kindlegen "TrueReddit - Top Stories.epub"

diff --git a/pypub/__init__.py b/pypub/__init__.py
@@ -1,14 +1,16 @@
-'epub.py functions and classes'
-from epub import Epub
+"""
+epub library designed to build and generate ebooks in ePub format
+"""
 
-'chapter.py functions and classes'
-from chapter import Chapter
-from chapter import ChapterFactory
-from chapter import create_chapter_from_url
-from chapter import create_chapter_from_file
-from chapter import create_chapter_from_string
-from chapter import save_image
+#** Variables **#
+__all__ = [
+    'Epub',
+    'Chapter',
 
-'clean.py functions and classes'
-from clean import clean
+    'create_chapter_from_url',
+    'create_chapter_from_file',
+    'create_chapter_from_string'
+]
 
+from .epub import *
+from .chapter import *