utilspie

utilspie : Utilities for Python

.. image:: https://img.shields.io/pypi/v/utilspie.svg :target: https://pypi.python.org/pypi/utilspie :alt: downloads

.. image:: https://travis-ci.org/moin18/utilspie.svg?branch=master :alt: build status :target: https://travis-ci.org/moin18/utilspie

.. image:: https://codecov.io/github/moin18/utilspie/coverage.svg?branch=master :target: https://codecov.io/github/moin18/utilspie :alt: codecov

.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg :target: https://github.com/moin18/utilspie/issues :alt: contributor-friendly

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg :target: http://utilspie.readthedocs.io/en/latest :alt: documentation

Documentation: utilspie.readthedocs.org <http://utilspie.readthedocs.io/en/latest/>_

What is utilspie?

Utilspie is a Python library that offers a sensible, human-friendly utilities which do not come along with Python installation. Utilspie is categorized into 5 modules:

• asyncutils <http://utilspie.readthedocs.io/en/latest/#utilspie-asyncutils>_: utilities for asynchronous call/threads
• fileutils <http://utilspie.readthedocs.io/en/latest/#utilspie-fileutils>_: utilities related to file operations/manipulations
• iterutils <http://utilspie.readthedocs.io/en/latest/#utilspie-iterutils>: utilities for iterators. Inspired by itertools <https://docs.python.org/2/library/itertools.html> package
• collectionsutils <http://utilspie.readthedocs.io/en/latest/#utilspie-collectionsutils>: provides data objects not present in collections <https://docs.python.org/2/library/collections.html> package
• importutils <http://utilspie.readthedocs.io/en/latest/#utilspie-importutils>_: utilities related to importing the modules

Installation

utilspie is available on pypi <https://pypi.python.org/pypi/utilspie>_. To install, run:

.. code-block:: bash

$ pip install utilspie

Quick Start

For using the utilspie, you have to import the package utilspie and call it's function as:

.. code-block:: python

from utilspie import iterutils
# OR, from utilspie.iterutils import get_chunks

iterutils.get_chunks([1, 2, 3, 4, 5, 6], 2)
<generator object <genexpr> at 0x1018fab40>
# returns generator object

list(iterutils.get_chunks([1, 2, 3, 4, 5, 6], 2))
[[1, 2], [3, 4], [5, 6]]

API Guide

---

utilspie.asyncutils

Contains utility functions for asynchronous calls.

• ordered_async_call(function_list) <http://utilspie.readthedocs.io/en/latest/#ordered-async-call>_

---

utilspie.fileutils

Contains utility functions for files related operations.

• copy_file(source, destination, unique, sort, case_sensitive, create_path) <http://utilspie.readthedocs.io/en/latest/#copy-file>_

---

utilspie.iterutils

Contains utility functions for iterables. It is inspired by itertools package.

• get_chunks(iterable_obj, chunk_size) <http://utilspie.readthedocs.io/en/latest/#get-chunks>_

---

utilspie.collectionsutils

Contains additional data objects not available as in-built in Python. This is inspired by collections module.

• frozendict(dict_obj) <http://utilspie.readthedocs.io/en/latest/#frozendict>_
• swap_dict(dict_obj, multivalued) <http://utilspie.readthedocs.io/en/latest/#swap-dict>_

---

utilspie.importutils

Contains utilites related to importing the modules.

• lazy_load_modules(*modules) <http://utilspie.readthedocs.io/en/latest/#lazy-load-modules>_
• reload_module(module) <http://utilspie.readthedocs.io/en/latest/#reload-module>_
• delete_module(modname) <http://utilspie.readthedocs.io/en/latest/#delete-module>_

Didn't find what you want?

Are you looking for something which you think should be the part of utilspie but is not currently present? Feel free to mention it by opening a issue <https://github.com/moin18/utilspie/issues>_. We will take a look at it, and will implement it if it's a good fit.

How to Contribute?

#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. #. Fork the repository_ on GitHub to start making your changes to the master branch (or branch off of it). #. Write a test which shows that the bug was fixed or that the feature works as expected. #. Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS_.

.. _the repository: http://github.com/moin18/utilspie .. _AUTHORS: https://github.com/moin18/utilspie/blob/master/AUTHORS.rst