pytool: Python helper package
#############################

This package contains a lot of helpful little methods and functions to make
your life a little easier and your day a little better. Enjoy!

If you would like to see something added here, feel free to open up a `GitHub
issue <https://github.com/shakefu/pytool/issues>`_.

.. contents::

:mod:`pytool.cmd`: Command helpers
==================================

.. automodule:: pytool.cmd

.. contents:: Command helpers
   :local:

:class:`pytool.cmd.Command`
---------------------------

.. autoclass:: pytool.cmd.Command
   :members:

:mod:`pytool.json`: JSON helpers
================================

.. currentmodule:: pytool.json

.. automodule:: pytool.json

.. contents:: JSON helpers
   :local:

:func:`as_json`
---------------

.. autofunction:: as_json

:func:`from_json`
-----------------

.. autofunction:: from_json

:mod:`pytool.lang`: Language helpers
====================================

.. currentmodule:: pytool.lang

.. automodule:: pytool.lang

.. contents:: Language helpers
   :local:

:class:`Namespace`
------------------

.. autoclass:: Namespace
   :members:

:class:`Keyspace`
------------------

.. autoclass:: Keyspace
   :members:

:class:`UNSET`
--------------

.. autoclass:: UNSET

:func:`classproperty`
---------------------

.. autofunction:: classproperty

:func:`get_name`
----------------

.. autofunction:: get_name

:func:`hashed_singleton`
------------------------

.. autofunction:: hashed_singleton

:func:`singleton`
-----------------

.. autofunction:: singleton

:func:`unflatten`
-----------------

.. autofunction:: unflatten

:mod:`pytool.text`: Text helpers
================================

.. currentmodule:: pytool.text

.. automodule:: pytool.text

.. contents:: Text helpers
   :local:

:func:`wrap`
------------

.. autofunction:: wrap

:func:`columns`
---------------

.. autofunction:: columns

:mod:`pytool.time`: Time and Date related helpers
=================================================

.. currentmodule:: pytool.time

.. automodule:: pytool.time

.. contents:: Time and Date related helpers
   :local:

:class:`Timer`
--------------

.. autoclass:: Timer
   :members:

:class:`UTC`
------------

.. autoclass:: UTC
   :members:

:func:`as_utc`
--------------

.. autofunction:: as_utc

:func:`utcnow`
--------------

.. autofunction:: utcnow

:func:`fromutctimestamp`
------------------------

.. autofunction:: fromutctimestamp

:func:`toutctimestamp`
----------------------

.. autofunction:: toutctimestamp

:func:`is_dst`
--------------

.. autofunction:: is_dst

:func:`trim_time`
-----------------

.. autofunction:: trim_time

:func:`floor_day`
-----------------

.. autofunction:: floor_day

:func:`floor_minute`
--------------------

.. autofunction:: floor_minute

:func:`floor_month`
-------------------

.. autofunction:: floor_month

:func:`floor_week`
------------------

.. autofunction:: floor_week

:func:`make_week_seconds`
-------------------------

.. autofunction:: make_week_seconds

:func:`week_seconds`
--------------------

.. autofunction:: week_seconds

:func:`week_seconds_to_datetime`
--------------------------------

.. autofunction:: week_seconds_to_datetime

:func:`week_start`
------------------

.. autofunction:: week_start

:func:`ago`
-----------

.. autofunction:: ago


:mod:`pytool.proxy`: DictProxy and ListProxy classes
====================================================

.. currentmodule:: pytool.proxy

.. automodule:: pytool.proxy

.. contents::
   :local:

:class:`DictProxy`
------------------

.. autoclass:: DictProxy
   :members:

:class:`ListProxy`
------------------

.. autoclass:: ListProxy
   :members: