Merge branch 'master' into fixes-1

Author: hellman

README.md

@@ -6,7 +6,17 @@ A tool to do some xor analysis:
   - guess the key length (based on count of equal chars)
   - guess the key (base on knowledge of most frequent char)
 
-**Notice:** xortool is moving to Python 3, the PyPI package will be upgraded soon. The old Python 2 version is accessible at the `py2` branch.
+**Notice:** xortool is now only running on Python 3. The old Python 2 version is accessible at the `py2` branch. The **pip** package has been updated.
+
+Installation
+---------------------
+
+**xortool** can be installed using **pip**. The recommended way is to run the following command, which installs xortool only for current user. Remove the `--user` flag and run from root if global installation is preferred.
+
+```bash
+python3 -m pip install --user xortool
+```
+
 
 Usage
 ---------------------
@@ -175,6 +185,6 @@ By filtering the outputs on the character set of Base64, we directly keep the on
 Information
 ---------------------
 
-Author: hellman ( hellman1908@gmail.com )
+Author: hellman
 
-License: MIT License (opensource.org/licenses/MIT)
+License: [MIT License](https://opensource.org/licenses/MIT)

setup.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
-# -*- coding:utf-8 -*-
 
-from distutils.core import setup
+from setuptools import setup
 
 import xortool
 
@@ -15,19 +14,21 @@
       url='https://github.com/hellman/xortool',
       description='Tool for xor cipher analysis',
       long_description=open("README.md").read(),  # not in rst, but something
+      long_description_content_type="text/markdown",
       keywords="xor xortool analysis",
 
       packages=['xortool'],
       provides=['xortool'],
       install_requires=['docopt>=0.6.1'],
+      setup_requires=['wheel'],
       scripts=["xortool/xortool", "xortool/xortool-xor"],
 
+      python_requires='>=3',
       classifiers=['Development Status :: 4 - Beta',
                    'Intended Audience :: Science/Research',
                    'Intended Audience :: Information Technology',
                    'Natural Language :: English',
                    'Operating System :: OS Independent',
-                   'Programming Language :: Python :: 2',
                    'Programming Language :: Python :: 3',
                    'License :: OSI Approved :: MIT License',
                    'Topic :: Scientific/Engineering :: Mathematics',

test/test.sh

@@ -191,9 +191,9 @@ tool_xored test/data/tool_xored
 
 xortool -c 00 --key-length=10 test/data/binary_xored
 f_cmp="$(grep 'secret_key' xortool_out/filename-key.csv|cut -d\; -f1)"
-./xortool/xortool-xor -n -r secret_key -f "$f_cmp" | \
+xortool-xor -n -r secret_key -f "$f_cmp" | \
     cmp test/data/binary_xored
-./xortool/xortool-xor -n -r secret_key -f test/data/binary_xored | \
+xortool-xor -n -r secret_key -f test/data/binary_xored | \
     cmp "$f_cmp"
 
 echo OK

xortool/__init__.py

@@ -1,2 +1,2 @@
 __all__ = "args", "colors", "libcolors", "routine"
-__version__ = "0.98"
+__version__ = "0.99"