Metadata-Version: 2.4
Name: plumbing
Version: 2.11.4
Summary: Helps with plumbing-type programing in python.
Author-email: Lucas Sinclair <lucas.sinclair@me.com>
License: Copyright (c) 2026 Lucas Sinclair
        
        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:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        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.
Project-URL: Homepage, http://github.com/xapple/plumbing/
Keywords: automation
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: autopaths>=1.6.2
Requires-Dist: pandas
Requires-Dist: retry
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: tzlocal
Requires-Dist: brewer2mpl
Provides-Extra: graphs
Requires-Dist: matplotlib; extra == "graphs"
Requires-Dist: numpy; extra == "graphs"
Provides-Extra: check-module
Requires-Dist: packaging; extra == "check-module"
Dynamic: license-file

[![PyPI version](https://badge.fury.io/py/plumbing.svg)](https://badge.fury.io/py/plumbing)

# `plumbing` version 2.11.4

This project contains functions and classes that help with plumbing-type programing and pipeline building.

It contains many classes and functions which have not yet all been documented.

## Prerequisites

Since `plumbing` is written in python, it is compatible with all operating systems: Linux, macOS and Windows. The only prerequisite is `python3` (which is often installed by default) along with the `pip3` package manager.

To check if you have `python3` installed, type the following on your terminal:

    $ python3 -V

If you do not have `python3` installed, please refer to the section [obtaining python3](docs/installing_tips.md#obtaining-python3).

To check you have `pip3` installed, type the following on your terminal:

    $ pip3 -V

If you do not have `pip3` installed, please refer to the section [obtaining pip3](docs/installing_tips.md#obtaining-pip3).

## Installing

To install the `plumbing` package, simply type the following commands on your terminal:

    $ pip3 install --user plumbing

Alternatively, if you want to install it for all users of the system:

    $ sudo pip3 install plumbing

## Extra documentation

More documentation is available at:

<http://xapple.github.io/plumbing/plumbing>

This documentation is simply generated with:

    $ pdoc --output-dir docs plumbing
