Metadata-Version: 1.1
Name: auxly
Version: 0.8.2
Summary: Python library for common shell-like script tasks.
Home-page: https://github.com/jeffrimko/Auxly
Author: Jeff Rimko
Author-email: jeffrimko@gmail.com
License: MIT
Description: |License| |Build Status|

        

        

        Introduction

        ============

        

        This project provides a Python 2.7/3.x library for common tasks

        especially when writing shell-like scripts. Some of the functionality

        overlaps with the standard library but the API is slightly modified.

        

        The goal of this project is to leverage the straightforward, clean

        syntax of Python while avoiding some of the boilerplate code that might

        be necessary when using the standard library. Functions that overlap

        with the standard library are designed to do what you would reasonably

        expect

        (`POLA <https://en.wikipedia.org/wiki/Principle_of_least_astonishment>`__)

        and, when necessary, fail **without** throwing exceptions.

        

        Please note when using this library that operations will fail silently.

        This is a deliberate design decision. However, there is often a way to

        check if an operation has failed and optionally throw and exception if

        that is desirable:

        

        .. code:: python

        

           auxly.filesys.copy("foo.txt", "bar") or auxly.throw()  # Throws/raises exception on failure.

        

        Auxly provides the following modules:

        

        -  `auxly <https://auxly.readthedocs.io/en/latest/#id1>`__

        

        -  `auxly.filesys <https://auxly.readthedocs.io/en/latest/#auxly-filesys>`__

        

        -  `auxly.shell <https://auxly.readthedocs.io/en/latest/#auxly-shell>`__

        

        -  `auxly.stringy <https://auxly.readthedocs.io/en/latest/#auxly-stringy>`__

        

        -  `auxly.listy <https://auxly.readthedocs.io/en/latest/#auxly-listy>`__

        

        The following are basic examples of Auxly (all examples can be found

        `here <https://github.com/jeffrimko/Auxly/tree/master/examples>`__):

        

        -  `examples/delete_pyc.py <https://github.com/jeffrimko/Auxly/blob/master/examples/delete_pyc.py>`__

           - Deletes all PYC files in the project.

        

        -  `examples/guess_os.py <https://github.com/jeffrimko/Auxly/blob/master/examples/guess_os.py>`__

           - Attempts to guess the host OS based on available shell commands.

        

        Refer to the unit tests

        `here <https://github.com/jeffrimko/Auxly/tree/master/tests>`__ for

        additional examples.

        

        

        Status

        ======

        

        Currently, this project is in the **development release** stage. While

        this project is suitable for use, please note that there may be

        incompatibilities in new releases.

        

        Release notes are maintained in the project

        `changelog <https://github.com/jeffrimko/Auxly/blob/master/CHANGELOG.adoc>`__.

        

        

        Requirements

        ============

        

        Auxly should run on any Python 2.7/3.x interpreter without additional

        dependencies.

        

        

        Installation

        ============

        

        Auxly can be installed with pip using the following command:

        ``pip install auxly``

        

        Additionally, Auxly can be installed from source by running:

        ``python setup.py install``

        

        

        Documentation

        =============

        

        The full documentation for this project can be found `here on Read the

        Docs <http://auxly.readthedocs.io>`__.

        

        

        Similar

        =======

        

        The following projects are similar and may be worth checking out:

        

        -  `Reusables <https://github.com/cdgriffith/Reusables>`__

        

        .. |License| image:: http://img.shields.io/:license-mit-blue.svg

        .. |Build Status| image:: https://github.com/jeffrimko/Auxly/workflows/tests/badge.svg

        
Keywords: cli script utility library
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
