1- Pytool |version |
2- ================
3-
4- Pytool is available on PyPI: `<http://pypi.python.org/pypi/pytool/ >`_
5-
6- Pytool is compatible with Python 2 (tested against 2.7) or Python 3.3 and
7- higher. *Compatibility added August 4, 2015. *
8-
9- Pytool's source is hosted on Github: `<http://github.com/shakefu/pytool >`_
10-
11- Any comments, issues or requests should be submitted via Github:
12- `<https://github.com/shakefu/pytool/issues >`_
1+ Pytool - Helpers for Python
2+ ===========================
3+
4+ Pytool is a Python helper package that contains a lot of helpful little methods
5+ and functions to make your life a little easier and your day a little better.
6+ Enjoy! These include:
7+
8+ * Command helpers for easily making CLI tools based on :mod: `argparse `
9+ * Language helpers which implement common Python language constructs like
10+ singletons, namespace objects, class properties, and proxy objects
11+ * Time helpers for easily working with UTC, relative times, and converting
12+ between formats
13+ * Text helpers to respect console width when wrapping and printing
14+ * JSON helpers for easily parsing and serializing JSON with customization
15+ * ... and more!
16+
17+ Pytool is compatible with Python 3.10 and higher. Older versions of Python are
18+ no longer supported going forward. If you need support for earlier Python
19+ versions, please check the `releases
20+ <https://github.com/shakefu/pytool/releases> `_ for older versions of Pytool.
21+ *Compatibility updated June 9, 2025. *
1322
1423Contributors
1524------------
@@ -18,19 +27,50 @@ Contributors
1827* `dshen109 <https://github.com/dshen109 >`_
1928* `abendig <https://github.com/abendig >`_
2029
30+ ----
31+
32+ Contents
33+ --------
34+
35+ .. contents ::
36+ :local:
2137
2238.. toctree ::
23- :maxdepth: 5
24- :titlesonly:
39+ :maxdepth: 3
2540
2641 pytool
2742
28-
2943.. toctree ::
3044 :hidden:
3145
3246 changes
3347
48+ Installation
49+ ^^^^^^^^^^^^
50+
51+ Pytool is available on PyPI: `<http://pypi.python.org/pypi/pytool/ >`_.
52+
53+ .. code-block :: bash
54+
55+ pip install pytool
56+
57+ Contributing
58+ ^^^^^^^^^^^^
59+
60+ Pytool is open source and available on Github:
61+ `<http://github.com/shakefu/pytool >`_.
62+
63+ Any comments, issues or requests should be submitted via Github:
64+ `<https://github.com/shakefu/pytool/issues >`_.
65+
66+ License
67+ ^^^^^^^
68+
69+ Pytool is licensed under the MIT License. See the `LICENSE
70+ <https://github.com/shakefu/pytool/blob/main/LICENSE.md> `_ file for details.
71+
72+ Changelog
73+ ^^^^^^^^^
3474
3575See the :doc: `changes ` for a list of changes.
3676
0 commit comments