First PyPI upload (v2.1.2)

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 
 # Distribution / packaging
 build/
+dist/
 *.egg-info/
 
 # SageMath parsed files

README.md

@@ -1,7 +1,7 @@
 usbrip
 ==========
 
-![usbrip-version](https://img.shields.io/badge/ver-2.1-red.svg)
+![usbrip-version](https://img.shields.io/badge/ver-2.1.2-red.svg)
 [![python-version](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/)
 [![license](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://raw.githubusercontent.com/snovvcrash/usbrip/master/LICENSE)
 [![built-with-love](https://img.shields.io/badge/built%20with-%F0%9F%92%97%F0%9F%92%97%F0%9F%92%97-lightgrey.svg)](https://emojipedia.org/growing-heart/)
@@ -13,8 +13,9 @@ usbrip
 Table of Contents:
 
 * [**Description**](#description)
+* [**Quick Start**](#quick-start)
 * [**Screenshots**](#screenshots)
-* [**Git clone**](#git-clone)
+* [**Git Clone**](#git-clone)
 * [**Dependencies**](#dependencies)
   - [DEB Packages](#deb-packages)
   - [PIP Packages](#pip-packages)
@@ -39,13 +40,22 @@ Besides, it also can:
 * *\*when installed with `-s` flag\** create crypted storages (7zip archives) to automatically backup and accumulate USB events with the help of `crontab` scheduler;
 * search additional details about a specific USB device based on its VID and/or PID.
 
+Quick Start
+==========
+
+Now you can download and install usbrip from [PyPI](https://pypi.org/project/usbrip/ "usbrip · PyPI"):
+
+```
+$ pip3 install usbrip
+```
+
 Screenshots
 ==========
 
 ![screenshot-1.png](https://user-images.githubusercontent.com/23141800/40887882-e00d4d3a-6757-11e8-962c-c77331782b19.png "Get USB event history")
 ![screenshot-2.png](https://user-images.githubusercontent.com/23141800/40886876-46c349d6-6748-11e8-92cf-0b0790ea9505.png "Search for extra details about a specific USB device")
 
-Git clone
+Git Clone
 ==========
 
 For simplicity, lets agree that all the commands where `~/usbrip$` prefix is appeared are executed in the `~/usbrip` directory which is created as a result of git clone:
@@ -77,7 +87,7 @@ usbrip makes use of the following external modules:
 * [terminaltables](https://github.com/Robpol86/terminaltables "Robpol86/terminaltables: Generate simple tables in terminals from a nested list of strings.")
 * [termcolor](https://pypi.org/project/termcolor "termcolor · PyPI")
 
-To resolve Python dependencies manually (it's not necessary actually because `pip` or `setup.py` can automate the process, see [Installation](#installation)) create a *virtual environment* and run `pip` from within:
+To resolve Python dependencies manually (it's not necessary actually because `pip` or `setup.py` can automate the process, see [Installation](#installation)) create a *virtual environment* (optional) and run `pip` from within:
 
 ```
 ~/usbrip$ python3 -m venv venv && source venv/bin/activate
@@ -90,6 +100,14 @@ Or let the `pipenv` one-liner do all the dirty work for you:
 ~/usbrip$ pipenv install && pipenv shell
 ```
 
+After that you can run usbrip portably:
+
+```
+(venv) ~/usbrip$ python -m usbrip [-h]
+Or
+(venv) ~/usbrip$ python __main__.py [-h]
+```
+
 Installation
 ==========
 

setup.py

@@ -22,10 +22,10 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 """
 
 __author__  = 'Sam Freeside (@snovvcrash)'
-__email__   = 'snovvcrash@protonmail[.]ch'
+__email__   = 'snovvcrash@protonmail.ch'
 __license__ = 'GPL-3.0'
 __site__    = 'https://github.com/snovvcrash/usbrip'
-__brief__   = 'USB device artifacts tracker.'
+__brief__   = 'USB device artifacts tracker'
 
 import glob
 import shutil
@@ -151,7 +151,7 @@ setup(
 
 	entry_points={
 		'console_scripts': [
-			'usbrip=usbrip.usbrip:main'
+			'usbrip=usbrip.__main__:main'
 		]
 	}
 )

usbrip/__init__.py

@@ -21,4 +21,4 @@ You should have received a copy of the GNU General Public License
 along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 """
 
-__version__ = '2.1'
+__version__ = '2.1.2'

usbrip/__main__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Usage: usbrip [-h]
+# Usage: python3 -m usbrip [-h]
 
 """LICENSE
 
@@ -27,7 +27,7 @@ __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __date__   = '2018-03-21'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'usbrip project"s driver program.'
+__brief__  = 'usbrip project\'s driver program'
 
 import re
 import os
@@ -414,3 +414,7 @@ def _validate_file_args(args):
 def _validate_vid_pid_args(args):
 	if 'vid' in args and 'pid' in args and not args.vid and not args.pid:
 		usbrip_arg_error('At least one of --vid/--pid or --download option should be specified')
+
+
+if __name__ == '__main__':
+    main()

usbrip/lib/core/common.py

@@ -24,7 +24,7 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'Common items.'
+__brief__  = 'Common items'
 
 import os
 import sys

usbrip/lib/core/config.py

@@ -24,7 +24,7 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'Config file containing cross-module variables.'
+__brief__  = 'Config file containing cross-module variables'
 
 import sys
 

usbrip/lib/core/usbevents.py

@@ -33,7 +33,7 @@ monitoring - Monitor history of USB flash drives - Unix & Linux Stack Exchange
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'USB events handler.'
+__brief__  = 'USB events handler'
 
 import re
 import codecs

usbrip/lib/core/usbids.py

@@ -29,7 +29,7 @@ USB Vendor/Device IDs Database - Linux-USB.org
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'USB IDs handler.'
+__brief__  = 'USB IDs handler'
 
 import re
 import socket

usbrip/lib/core/usbstorage.py

@@ -24,7 +24,7 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'USB Storage handler.'
+__brief__  = 'USB Storage handler'
 
 import re
 import json

usbrip/lib/parse/argparser.py

@@ -24,7 +24,7 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'Command line option parser.'
+__brief__  = 'Command line option parser'
 
 from argparse import ArgumentParser
 

usbrip/lib/utils/debug.py

@@ -24,7 +24,7 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'Debug utils.'
+__brief__  = 'Debug utils'
 
 import functools
 import time

usbrip/lib/utils/timing.py

@@ -24,7 +24,7 @@ along with usbrip.  If not, see <http://www.gnu.org/licenses/>.
 __author__ = 'Sam Freeside (@snovvcrash)'
 __email__  = 'snovvcrash@protonmail[.]ch'
 __site__   = 'https://github.com/snovvcrash/usbrip'
-__brief__  = 'Program runtime meter.'
+__brief__  = 'Program runtime meter'
 
 import atexit
 import time