README for pympler
==================

[![Latest Version](https://img.shields.io/pypi/v/pympler.svg)](https://pypi.org/project/Pympler/)
[![License](https://img.shields.io/pypi/l/pympler.svg)](https://pypi.org/project/Pympler/)


Before installing Pympler, try it with your Python version:

    python setup.py try

If any errors are reported, check whether your Python version is supported.
Pympler is written entirely in Python, with no dependencies other than standard
Python modules and libraries. Pympler works with Python 2.7, 3.5, 3.6, 3.7, 3.8
and 3.9.

Installation
------------

For a system-wide installation run:

    python setup.py install

Test the installed Pympler package:

    python setup.py test


Usage
-----

The usage of pympler is described in the documentation.  It is
available either in this distribution at *doc/index.html* or
you can [read it online](https://pympler.readthedocs.io/en/latest/).


Contributing
------------

You can post wishes, bug reports or patches at our
[issue tracker](https://github.com/pympler/pympler/issues) or
write an email to *pympler-dev@googlegroups.com*.


[![Build status](https://secure.travis-ci.org/pympler/pympler.png?branch=master)](http://travis-ci.org/pympler/pympler)
[![Coverage Status](https://coveralls.io/repos/pympler/pympler/badge.svg?branch=master)](https://coveralls.io/r/pympler/pympler?branch=master)
