Metadata-Version: 2.0
Name: Python-Bash-Utils
Version: 0.1.4
Summary: A package which allows making bash style command line scripts easier.
Home-page: https://bitbucket.org/tsantor/python-bash-utils
Author: Tim Santor
Author-email: tsantor@xstudios.agency
License: MIT
Download-URL: https://bitbucket.org/tsantor/python-bash-utils/get/0.1.4.tar.gz
Keywords: bash utils colors log
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: six (>=1.9.0)

Python Bash Utils
=================

Author: Tim Santor tsantor@xstudios.agency

Overview
========

Bash color management and log system for Python users.

|Latest Version| |Downloads| |Development Status| |License|

Requirements
============

-  Python 2.7.x, 3.4.x

    NOTE: This has only been tested on a Mac (10.10.2) at this time.

Installation
============

You can install directly via pip:

::

    pip install python-bash-utils

Or from the BitBucket repository (master branch by default):

::

    git clone https://bitbucket.org/tsantor/python-bash-utils
    cd python-bash-utils
    sudo python setup.py install

Usage
=====

colors
------

Import:

::

    from bashutils import colors

Functions:

::

    colors.color_text(text, color="none")

logmsg
------

Import:

::

    from bashutils import logmsg

Functions:

::

    logmsg.log_divline()             # ----------
    logmsg.log_header('header')      # ==> header
    logmsg.log_success('success')    # [✓] success
    logmsg.log_error('error')        # [✗] error
    logmsg.log_warning('warning')    # [!] warning
    logmsg.log_info('info')          # [i] info
    logmsg.log_declined('something') # [✗] something declined. Skipping...

bashutils
---------

Import:

::

    from bashutils import bashutils

Functions:

::

    bashutils.get_os() # OSX, 'Fedora', 'CentOS', 'Debian', 'Ubuntu'

    status, stdout, stderr = bashutils.exec_cmd('git -h')

    bashutils.cmd_exists('git') # True or False

    bashutils.file_exists('/path/to/file.ext')
    bashutils.delete_file('/path/to/file.ext')
    bashutils.dir_exists('/path/to/dir')
    bashutils.make_dir('/path/to/dir')
    bashutils.delete_dir('/path/to/dir')

Version History
===============

-  **0.1.0** - Initial release
-  **0.1.1** - Added some new methods
-  **0.1.2** - Refactor
-  **0.1.3** - Added Python 3.4.x support

Issues
======

If you experience any issues, please create an
`issue <https://bitbucket.org/tsantor/python-bash-utils/issues>`__ on
Bitbucket.

.. |Latest Version| image:: https://pypip.in/version/python-bash-utils/badge.svg
   :target: https://pypi.python.org/pypi/python-bash-utils/
.. |Downloads| image:: https://pypip.in/download/python-bash-utils/badge.svg
   :target: https://pypi.python.org/pypi/python-bash-utils/
.. |Development Status| image:: https://pypip.in/status/python-bash-utils/badge.svg
   :target: https://pypi.python.org/pypi/python-bash-utils/
.. |License| image:: https://pypip.in/license/python-bash-utils/badge.svg
   :target: https://pypi.python.org/pypi/python-bash-utils/


