Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
tests
utilspie
.coveragerc
.gitignore
.travis.yml
AUTHORS.rst
LICENSE
Makefile
README.rst
requirements.txt
setup.cfg
setup.py

README.rst

utilspie : Utilities for Python

downloads build status codecov contributor-friendly documentation

Documentation: utilspie.readthedocs.org

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:

Installation

utilspie is available on pypi. To install, run:

$ pip install utilspie

Quick Start

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

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.

utilspie.fileutils

Contains utility functions for files related operations.

utilspie.iterutils

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

utilspie.collectionsutils

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

utilspie.importutils

Contains utilites related to importing the modules.

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. We will take a look at it, and will implement it if it's a good fit.

How to Contribute?

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