Metadata-Version: 2.4
Name: rpipe
Version: 9.10.2
Summary: A little python remote pipe server and client.
License: GPLv3
Project-URL: Homepage, https://github.com/zwimer/rpipe
Keywords: remote,pipe
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: zstandard[cffi]
Requires-Dist: pycryptodomex
Requires-Dist: cryptography
Requires-Dist: argcomplete
Requires-Dist: requests
Requires-Dist: tqdm
Requires-Dist: zstdlib>=0.0.8
Requires-Dist: waitress
Requires-Dist: wcmatch
Requires-Dist: flask
Requires-Dist: human_readable
Dynamic: license-file

# rpipe
A little python remote pipe server and client.

# Install

`pip install rpipe`

# Usage

Before anything else, you should set your pipe server URL and default channel (the default channel can be any string)
```bash
export RPIPE_PASSWORD="my password"  # Only need to set when saving config
rpipe --url <url> -c <channel> --password-env --save_config
```

If no password is desired, use `--no-password`; though data will be uploaded without encryption if this is done.

### Sending
```bash
echo "abc" | rpipe
```

### Receiving
```bash
rpipe        # Read the data
rpipe -c foo # Read data from the channel "foo"
rpipe --peek # Read the data but do not remove it from the server
```

Additional options can be found via `rpipe --help`.
Note that peeking will only show the data presently available, it will not construct a persistent pipe like reading will.

### Web Version

While discouraged and lacking support for encryption, users can forgo usage of the `rpipe` client and connect directly to an `rpipe` with simple `GET`/`POST` requests.
Visit the server's URL `/help` for more details.

### Custom URL or channel
Both sending and receiving support the command line options `-c`/`--channel` and `-u`/`--url` to use a different channel or URL than is saved.


# Server

Start the server via:
```bash
rpipe_server <port> [--host <host>] [--debug]
```
