Merge branch 'release/v0.9.6'

rsnitsch · Aug 29, 2019 · d9ceeca · d9ceeca
2 parents cb518cf + 5bdef85
commit d9ceeca
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+docs/build/
+src/__pycache__/
diff --git a/.hgignore b/.hgignore
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1,6 +1,15 @@
 Changelog
 =========
 
+Version 0.9.6
+-------------
+
+*Release date: 2019/08/29*
+
+* new: exit gracefully if py3bencode module could not be imported and show
+  instructions on how to fix this
+* docs: Updated docs after migration from Mercurial/Bitbucket.org to Git/Github.com
+
 Version 0.9.5
 -------------
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '0.9'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.0-dev'
+release = '0.9.6'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/user.rst b/docs/source/user.rst
@@ -29,13 +29,13 @@ py3createtorrent is intended to fill this gap.
 Requirements
 ------------
 
-py3createtorrent requires at least Python 3.1 and the `py3bencode <https://bitbucket.org/rsnitsch/py3bencode>`_ module.
+py3createtorrent requires at least Python 3.1 and the `py3bencode <https://github.com/rsnitsch/py3bencode>`_ module.
 
 Installation
 ------------
 
 Download the desired version from here:
-https://bitbucket.org/rsnitsch/py3createtorrent/downloads
+https://github.com/rsnitsch/py3createtorrent/releases
 
 The required py3bencode module is shipped alongside py3createtorrent. As long
 as you extract py3bencode into the same directory as the py3createtorrent script,
@@ -51,15 +51,15 @@ Python installation.
 You can use `pip <http://www.pip-installer.org/>`_ to install the py3bencode
 module in your Python installation (in the site-packages, to be precise)::
 
-   pip install hg+https://bitbucket.org/rsnitsch/py3bencode
+   pip install git+https://github.com/rsnitsch/py3bencode
 
 Make sure to use the pip executable that belongs to the Python interpreter
 with which you will execute py3createtorrent.
 
 If you don't have pip around (although I strongly recommend using it) you can
 also try to install py3bencode manually::
 
-   $ hg clone https://bitbucket.org/rsnitsch/py3bencode
+   $ git clone https://github.com/rsnitsch/py3bencode
    $ cd py3bencode
    $ python3 setup.py install
 

diff --git a/src/py3createtorrent.py b/src/py3createtorrent.py
@@ -15,7 +15,23 @@
 import sys
 import time
 
-from py3bencode import bencode
+try:
+    from py3bencode import bencode
+except ImportError as exc:
+    print("ERROR:")
+    print("""py3bencode module could not be imported.
+
+Please install the py3bencode module using
+
+    pip install git+https://github.com/rsnitsch/py3bencode
+
+or refer to the documentation on how to install it:
+https://py3createtorrent.readthedocs.io/en/latest/""")
+    print()
+    print()
+    print("-"*40)
+    print()
+    raise
 
 __all__ = ['calculate_piece_length',
            'get_files_in_directory',
@@ -39,7 +55,7 @@
 # do not touch anything below this line unless you know what you're doing!
 
 
-VERSION =   '1.0.0-dev'
+VERSION =   '0.9.6'
 
 # Note:
 #  Kilobyte = kB  = 1000 Bytes