Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# LICENSE
# The MIT License (MIT)

Copyright 2012 Jacob Alheid
Copyright © 2025 Jacob Alheid

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

http://www.apache.org/licenses/LICENSE-2.0
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
70 changes: 55 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
Pytool |version|
================

Pytool is available on PyPI: `<http://pypi.python.org/pypi/pytool/>`_

Pytool is compatible with Python 2 (tested against 2.7) or Python 3.3 and
higher. *Compatibility added August 4, 2015.*

Pytool's source is hosted on Github: `<http://github.com/shakefu/pytool>`_

Any comments, issues or requests should be submitted via Github:
`<https://github.com/shakefu/pytool/issues>`_
Pytool - Helpers for Python
===========================

Pytool is a Python helper package that contains a lot of helpful little methods
and functions to make your life a little easier and your day a little better.
Enjoy! These include:

* Command helpers for easily making CLI tools based on :mod:`argparse`
* Language helpers which implement common Python language constructs like
singletons, namespace objects, class properties, and proxy objects
* Time helpers for easily working with UTC, relative times, and converting
between formats
* Text helpers to respect console width when wrapping and printing
* JSON helpers for easily parsing and serializing JSON with customization
* ... and more!

Pytool is compatible with Python 3.10 and higher. Older versions of Python are
no longer supported going forward. If you need support for earlier Python
versions, please check the `releases
<https://github.com/shakefu/pytool/releases>`_ for older versions of Pytool.
*Compatibility updated June 9, 2025.*

Contributors
------------
Expand All @@ -18,19 +27,50 @@ Contributors
* `dshen109 <https://github.com/dshen109>`_
* `abendig <https://github.com/abendig>`_

----

Contents
--------

.. contents::
:local:

.. toctree::
:maxdepth: 5
:titlesonly:
:maxdepth: 3

pytool


.. toctree::
:hidden:

changes

Installation
^^^^^^^^^^^^

Pytool is available on PyPI: `<http://pypi.python.org/pypi/pytool/>`_.

.. code-block:: bash

pip install pytool

Contributing
^^^^^^^^^^^^

Pytool is open source and available on Github:
`<http://github.com/shakefu/pytool>`_.

Any comments, issues or requests should be submitted via Github:
`<https://github.com/shakefu/pytool/issues>`_.

License
^^^^^^^

Pytool is licensed under the MIT License. See the `LICENSE
<https://github.com/shakefu/pytool/blob/main/LICENSE.md>`_ file for details.

Changelog
^^^^^^^^^

See the :doc:`changes` for a list of changes.

Expand Down
Loading