Metadata-Version: 1.1
Name: osome
Version: 0.1.2
Summary: The bucket of python shell helpers, no dependencies, simple API.
Home-page: https://github.com/xando/osome
Author: Sebastian Pawluś
Author-email: sebastian.pawlus@gmail.com
License: Copyright (c) 2012, Sebastian Pawluś.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer. 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies, 
either expressed or implied, of the FreeBSD Project.
Description: osome
        =====
        
        The bucket of python shell wrappers around os library, no dependencies, simple API.
        
        * Python2.6
        * Python2.7
        * Python3.3
        * PyPy1.9
        
        - osome: (python os module wrappers)
        
          - path - path wraper around all methods related to path manipulation
          - run - subprocess wrapper
        
        
        Documentation
        -------------
        https://osome.readthedocs.org/
        
        
        Code
        ----
        https://github.com/xando/osome
        
        
        Install
        -------
        
        .. code-block:: bash
        
           pip install osome
        
        
        
        osome.path
        ---------------
        
        .. code-block:: python
        
           >>> from osome import path
        
           >>> path('/var/log')
           /var/log
        
           >>> path('/var', 'log')
           /var/log
        
           >>> path('/var/log').own
           '766'
        
           >>> path('/var/log').is_dir()
           True
        
           >>> for e in path('/var/log'):
           ...     print e
           /var/log/boot.log
           /var/log/dmesg
           /var/log/faillog
           /var/log/kern.log
           /var/log/gdm
        
           >>> path('/var/log/').ls('*log')
           [/var/log/boot.log, /var/log/faillog, /var/log/kern.log]
        
           >>> path('/var/log') / 'syslog'
           /var/log/syslog
        
           >>> (path('/var/log') / 'syslog').exists
        
           >>> path('/var/log','syslog').open('r')
           <open file '/var/log/syslog', mode 'r' at 0x294c5d0>
        
           >>> path('/var/log').cp('copy', r=True)
           copy
        
           >>> path('/home/user/test_tmp_directory').replace('_', '-')
           '/home/user/test-tmp-directory'
        
           >>> location = path('/home/user/test_tmp_directory')
           >>> location.mv( location.replace('_', '-') )
        
        
        osome.run
        --------------
        
        
        .. code-block:: python
        
          >>> from osome import run
        
          >>> print run('uname -r').stdout
          3.7.0-7-generic
        
          >>> run('uname -a').status
          0
        
          >>> print run('rm not_existing_directory').stderr
          rm: cannot remove `not_existing_directory': No such file or directory
        
          >>> print run('ls -la', 'wc -l', 'wc -c')
          3
        
          >>> print run('ls -la').stdout.lines
          ['total 20',
           'drwxrwxr-x 3 user user 4096 Dec 20 22:55 .',
           'drwxrwxr-x 5 user user 4096 Dec 20 22:57 ..',
           'drwxrwxr-x 2 user user 4096 Dec 20 22:37 dir',
           '-rw-rw-r-- 1 user user    0 Dec 20 22:52 file']
        
        
        .. code-block:: python
        
          from osome import run
        
          run('grep something', data=run.stdin)
        
        .. code-block:: bash
        
          $ ps aux | python script.py
        
        
        tests
        -----
        
        .. image:: https://api.travis-ci.org/xando/osome.png?branch=master
        
        Travis CI, https://travis-ci.org/xando/osome
        
        
        Tests are implemented with `py.tests
        <http://pytest.org/>`_, to run:
        
        .. code-block:: bash
        
           python runtests.py
        
        
        based on/inspired by
        --------------------
        
        * http://www.ruby-doc.org/stdlib-1.9.3/libdoc/fileutils/rdoc/index.html
        * https://github.com/kennethreitz/clint
        * https://github.com/jaraco/path.py
        
        
        author
        ------
        
        * Sebastina Pawluś (sebastian.pawlus@gmail.com)
        
        
        contributors
        ------------
        
        * Jakub (kuba.janoszek@gmail.com)
        * Angel Ezquerra
        
Keywords: shell tools shell path
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
