Metadata-Version: 2.1
Name: sizeof
Version: 0.1.1
Summary: Simple function for measuring the size in memory of common Python data structures.
Home-page: https://github.com/lapets/sizeof
Author: Andrei Lapets
Author-email: a@lapets.io
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/x-rst

======
sizeof
======

Simple function for measuring the size in memory of common Python data structures.

|pypi| |travis| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/sizeof.svg
   :target: https://badge.fury.io/py/sizeof
   :alt: PyPI version and link.

.. |travis| image:: https://travis-ci.com/lapets/sizeof.svg?branch=master
   :target: https://travis-ci.com/lapets/sizeof

.. |coveralls| image:: https://coveralls.io/repos/github/lapets/sizeof/badge.svg?branch=master
   :target: https://coveralls.io/github/lapets/sizeof?branch=master

Package Installation and Usage
------------------------------
The package is available on PyPI::

    python -m pip install sizeof

The library can be imported in the usual ways::

    import sizeof
    from sizeof import sizeof

Testing and Conventions
-----------------------
All unit tests are executed and their coverage is measured when using `nose <https://nose.readthedocs.io/>`_ (see ``setup.cfg`` for configution details)::

    nosetests

Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`_::

    python sizeof/sizeof.py -v

Style conventions are enforced using `Pylint <https://www.pylint.org/>`_::

    pylint sizeof

Contributions
-------------
In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning
----------
The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`_.


