rgmining/common

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Common library for Review Graph Mining
[![GPLv3](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://www.gnu.org/copyleft/gpl.html)
[![Build Status](https://travis-ci.org/rgmining/common.svg?branch=master)](https://travis-ci.org/rgmining/common)
[![wercker status](https://app.wercker.com/status/00645c6dedb906005bbc6c080290f5f6/s/master "wercker status")](https://app.wercker.com/project/byKey/00645c6dedb906005bbc6c080290f5f6)
[![Code Climate](https://codeclimate.com/github/rgmining/common/badges/gpa.svg)](https://codeclimate.com/github/rgmining/common)
[![Release](https://img.shields.io/badge/release-0.9.1-brightgreen.svg)](https://github.com/rgmining/common/releases/tag/v0.9.1)

The common module and its submodules probides varies functions ans classes
which can be used in any context.

The main functions provided by this package are followings:

* `print_args`: Decorate a function so that print arguments before calling it.
* `print_return`: Decorate a function so that print result after calling it.
* `constant`: Decorate a function so that the result is a constant value.
* `memoized`: Decorate a function to memoize results.

See [documents](https://rgmining.github.io/common/) for more information.

## Installation
Use `pip` to install this package.

```shell
pip install --upgrade rgmining-common
```


## License
This software is released under The GNU General Public License Version 3,
see [COPYING](COPYING) for more detail.