Version 0.6.0 (#17)

* Removing argparse / command line option. Adding first tests and docs to new functions.

* Adding defaults confignamespace methods, adding change_logger_level, fixes

* [skip ci] Adding cross version run command

* Adding tests, docstrings and updates for run.

* Fixing nix tests

* Fixing timeout version discrepancies.

* PY2 vs PY3 testing

* Python 2.6 is dumb

* [ci skip] Fix import error in wrappers

* Fix setup.py error

* [skip ci] Adding new tasker ability

* [skip ci] Adding new download function

* Making logger safer, expanding run_in_pool

* Pythox 2.x fixes

* [skip ci] Adding pushd and popd as well as timed example of find fines compared to find

* [skip ci] Command line helpers

* [skip ci] Adding match specifications and readme updates

* [skip ci] Expanding readme

* [skip ci] Better command for running stuff from interpreter, expansion of readme

* Overhauled tasker, should be working

* Rename tasker to something meaningful. Adding ability to stop when tasklist finished

* Adding basic file server

* Making clear that it is a file server

* Testing a bit more of download

* Adding reusable tests

* Fixing called process errors for non 3.5 pythons

* maybe 2.6 will work this time

* Windows and pypy fixes.

* python 2.6 subprocess fix

* Adding new documentation. Improving testing.

* Adding bad size documentation

* Threaded instead of MP FileServer

* Increase test coverage

* Preparations for Version 0.6.0

* Updating documentation for Version 0.6.0

* Trying out new documentation

* [ci skip] hopefully last doc fixes

Author: cdgriffith

.coveragerc

@@ -7,12 +7,11 @@ omit =
     */nose/*
 exclude_lines =
     pragma: no cover
-    except Exception as err
+    except Exception
     conn.close
     raise BrowserException
     object.__setattr__
     raise AttributeError
-    raise AttributeError
     object.__delattr__
     elif "darwin"
     return "mac"
@@ -21,3 +20,8 @@ exclude_lines =
     except OSError as err
     raise err
     except NameError
+    def _background_runner
+    raise TypeError
+    self.free_tasks
+    self.busy_tasks
+    self.current_tasks

.noserc

@@ -0,0 +1,2 @@
+[nosetests]
+nocapture=1

CHANGES.rst

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+Version 0.6.0
+-------------
+
+- Adding multiprocessing helpers, Tasker class and run_in_pool
+- Adding download and cmd helper functions
+- Adding ThreadedServer class, for running a server (defaults to local file server) in the background
+- Adding terminal analogue functions: cd, pwd, ls, pushd, popd
+- Adding match_case option for find_all_files and count_all_files
+- Fix 'run' call to CalledProcessError on older python versions
+- Changing logger to _logger to be hidden by default (should not be breaking, if so you coded wrong)
+
 Version 0.5.2
 -------------
 

README.rst

@@ -1,7 +1,9 @@
 Reusables
 =========
 
-**Commonly Consumed Code Commodities** |BuildStatus| |CoverageStatus| |DocStatus| |PyPi| |License|
+|BuildStatus| |CoverageStatus| |License| |PyPi| |DocStatus|
+
+**Commonly Consumed Code Commodities**
 
 Overview
 --------
@@ -11,7 +13,6 @@ programmers may find themselves often recreating.
 
 It includes:
 
-- Cookie Management for Firefox and Chrome
 - Archive extraction (zip, tar, rar)
 - Path (file and folders) management
 - Fast logging setup
@@ -20,6 +21,10 @@ It includes:
 - Config to dict parsing
 - Common regular expressions and file extensions
 - Unique function wrappers
+- Bash analogues
+- Easy downloading
+- Multiprocessing helpers
+- Cookie Management for Firefox and Chrome
 
 Reusables is designed to not require any imports outside the standard library,
 but can be supplemented with those found in the requirements.txt file for
@@ -45,15 +50,15 @@ General Helpers and File Management
 
         import reusables
 
+        reusables.find_all_files(".", ext=reusables.exts.pictures)
+        # ['/home/user/background.jpg', '/home/user/private.png']
+
         reusables.extract_all("test/test_structure.zip", "my_archive")
         # All files in the zip will be extracted into directory "my_archive"
 
         reusables.config_dict('my_config.cfg')
         # {'Section 1': {'key 1': 'value 1', 'key2': 'Value2'}, 'Section 2': {}}
 
-        reusables.find_all_files(".", ext=reusables.exts.pictures)
-        # ['/home/user/background.jpg', '/home/user/private.png']
-
         reusables.count_all_files(".")
         # 405
 
@@ -63,23 +68,8 @@ General Helpers and File Management
         reusables.safe_path('/home/user/eViL User\0\\/newdir$^&*/new^%file.txt')
         # '/home/user/eViL User__/newdir____/new__file.txt'
 
-
-Cookie Management
-~~~~~~~~~~~~~~~~~
-
-Firefox and Chrome Cookie management. (Chrome requires SQLite 3.8 or greater.)
-
-.. code:: python
-
-        fox = reusables.FirefoxCookies()
-        # Automatically uses the DB of the default profile, can specify db=<path>
-
-        fox.add_cookie("example.com", "MyCookie", "Cookie contents!")
-
-        fox.find_cookies(host="Example")
-        # [{'host': u'example.com', 'name': u'MyCookie', 'value': u'Cookie contents!'}]
-
-        fox.delete_cookie("example.com", "MyCookie")
+        reusables.run("echo 'hello there!'", shell=True)
+        # CompletedProcess(args="echo 'hello there!'", returncode=0, stdout='hello there!\n')
 
 Namespace
 ~~~~~~~~~
@@ -108,7 +98,46 @@ that sub-dictionaries are recursively made into namespaces.
         # {'spam': <Namespace: {'eggs': {'sausage': {'bacon': '...>}
         # This is NOT the same as .to_dict() as it is not recursive
 
+Command line helpers
+--------------------
+
+Use the Python interpreter as much as a shell? Here's some handy helpers to
+fill the void. (Please don't do 'import *' in production code, this is used
+as an easy to use example using the interpreter interactively.)
+
+.. code:: python
+
+        from reusables import *
 
+        cd("~") # Automatic user expansion unlike os.chdir()
+
+        pwd()
+        # '/home/user'
+
+        pushd("Downloads")
+        # ['Downloads', '/home/user']
+
+        pwd()
+        # '/home/user/Downloads'
+
+        popd()
+        # ['/home/user']
+
+        ls("-lah")  # Uses 'ls' on linux and 'dir' on windows
+        #  total 1.5M
+        #  drwxr-xr-x 49 james james 4.0K Nov  1 20:09 .
+        #  drwxr-xr-x  3 root  root  4.0K Aug 21  2015 ..
+        #  -rw-rw-r--  1 james james  22K Aug 22 13:21 picture.jpg
+        #  -rw-------  1 james james  17K Nov  1 20:08 .bash_history
+
+        cmd("ifconfig") # Shells, decodes and prints 'reusables.run' output
+        #   eth0      Link encap:Ethernet  HWaddr de:ad:be:ef:00:00
+        #             inet addr:10.0.2.5  Bcast:10.0.2.255  Mask:255.255.255.0
+        #             ...
+
+        download('https://www.python.org/ftp/python/README.html', save_to_file=False)
+        # 2016-11-02 10:37:23,644 - reusables.web  INFO      Downloading https://www.python.org/ftp/python/README.html (2.3 KB) to memory
+        # b'<PRE>\nPython Distribution...
 
 DateTime
 ~~~~~~~~
@@ -228,11 +257,14 @@ That's right, str.endswith_ (as well as str.startswith_) accept a tuple to searc
  File Type             Extensions
 ===================== ===================
  pictures              .jpeg .jpg .png .gif .bmp .tif .tiff .ico .mng .tga .psd .xcf .svg .icns
- video                 .mkv .avi .mp4 .mov .flv .mpeg .mpg .3gp .m4v .ogv .asf .m1v .m2v .mpe .ogv .wmv .rm .qt
+ video                 .mkv .avi .mp4 .mov .flv .mpeg .mpg .3gp .m4v .ogv .asf .m1v .m2v .mpe .ogv .wmv .rm .qt .3g2 .asf .vob
  music                 .mp3 .ogg .wav .flac .aif .aiff .au .m4a .wma .mp2 .m4a .m4p .aac .ra .mid .midi .mus .psf
- documents             .doc .docx .pdf .xls .xlsx .ppt .pptx .csv .epub .gdoc .odt .rtf .txt .info .xps .gslides .gsheet
+ documents             .doc .docx .pdf .xls .xlsx .ppt .pptx .csv .epub .gdoc .odt .rtf .txt .info .xps .gslides .gsheet .pages .msg .tex .wpd .wps .csv
  archives              .zip .rar .7z .tar.gz .tgz .gz .bzip .bzip2 .bz2 .xz .lzma .bin .tar
  cd_images             .iso .nrg .img .mds .mdf .cue .daa
+ scripts               .py .sh .bat
+ binaries              .msi .exe
+ markup                .html .htm .xml .yaml .json .raml .xhtml .kml
 ===================== ===================
 
 
@@ -250,12 +282,44 @@ different take that requires the function returns a result not yet provided.
         return random.randint(0, 100)
 
 
+Cookie Management
+~~~~~~~~~~~~~~~~~
+
+Firefox and Chrome Cookie management. (Chrome requires SQLite 3.8 or greater.)
+
+.. code:: python
+
+        fox = reusables.FirefoxCookies()
+        # Automatically uses the DB of the default profile, can specify db=<path>
+
+        fox.add_cookie("example.com", "MyCookie", "Cookie contents!")
+
+        fox.find_cookies(host="Example")
+        # [{'host': u'example.com', 'name': u'MyCookie', 'value': u'Cookie contents!'}]
+
+        fox.delete_cookie("example.com", "MyCookie")
+
+
+FAQ
+---
+
+**How can I help? / Why doesn't it do what I want it too?**
+
+Please feel free to make suggestions in the 'issues' section of github, or to be super duper helpful go ahead and submit a PR for the
+functionality you want to see! Only requirements are that it's well thought out and is more in place here rather than it's own project
+(to be merged will need documentation and basic unittests as well, but not a requirement for opening the PR).
+Please don't hesitate if you're new to python! Even the smallest PR contributions will earn a mention in a brand new Contributors section.
+
+
+**Why all the underscored imports?**
 
-Common Issues
--------------
+The rational behind this is just like the standard library, so that the user is sure anything they have access to is solely from this library
+and not one of it's imports. Several variables are also hidden like this, as they are only to be used by the library itself. For example, loggers
+should not have their objects modified by direct reference, but rather obtained through 'logging.getLogger('reusables')', as it helps sort out those who
+know what they are doing.
 
-**UnRAR path issues**
 
+**Unrar not installed?**
 
 A common error to see, especially on Windows based systems, is: "rarfile.RarCannotExec: Unrar not installed? (rarfile.UNRAR_TOOL='unrar')"
 
@@ -318,5 +382,7 @@ improve existing code is warmly welcomed!
    log
    datetime
    namespace
+   web
+   multiprocess_helpers
    wrappers
    changelog

doc/source/conf.py

@@ -31,7 +31,7 @@
 shutil.copy(os.path.join("..", "..", "README.rst"), "index.rst")
 shutil.copy(os.path.join("..", "..", "CHANGES.rst"), "changelog.rst")
 
-with open(os.path.join("..", "..", "reusables", "reusables.py"), "r") as reuse_file:
+with open(os.path.join("..", "..", "reusables", "__init__.py"), "r") as reuse_file:
     reuse_content = reuse_file.read()
 
 

doc/source/multiprocess_helpers.rst

@@ -0,0 +1,6 @@
+Multiprocess Helpers
+====================
+
+.. automodule:: reusables.multiprocess_helpers
+   :members:
+   :undoc-members:

doc/source/web.rst

@@ -0,0 +1,6 @@
+Web Based Helpers
+=================
+
+.. automodule:: reusables.web
+   :members:
+   :undoc-members:

reusables/__init__.py

@@ -5,6 +5,8 @@
 from .log import *
 from .browser import *
 from .wrappers import *
+from .multiprocess_helpers import *
+from .web import *
 
 __author__ = "Chris Griffith"
-__version__ = "0.5.2"
+__version__ = "0.6.0"