Metadata-Version: 2.1
Name: enso-nic
Version: 0.1.2
Summary: Python frontend for the Ensō dataplane.
Home-page: https://github.com/hsadok/enso
Download-URL: https://github.com/hsadok/enso
Author: Hugo Sadok
Author-email: sadok@cmu.edu
License: BSD
Keywords: network,enso,dataplane,nic
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Ensō Python Frontend

## Install

To install the frontend run in the current directory (`frontend`):
```bash
pip3 install -e .
```
To run the EnsōGen packet generator you also need to have the `capinfos` command installed in the machine you want to use to generate packets.

On Ubuntu (or other Debian-based system) run:
```bash
sudo apt install tshark
```

For other distributions refer to the [wireshark docs](https://tshark.dev/setup/install/#installing-tshark-only) to find the correct package name (either `tshark` or `wireshark-cli`).

## Running

For usage information run:
```bash
enso --help
```

## Enable autocompletion (optional)

#### For Bash
Run this:
```bash
_ENSO_COMPLETE=bash_source enso > ~/.enso-complete.bash
```

Then add the following to your `.bashrc`:
```bash
. ~/.enso-complete.bash
```

#### For Zsh
Run this:
```zsh
_ENSO_COMPLETE=zsh_source enso > ~/.enso-complete.zsh
```

Then add the following to your `.zshrc`:
```zsh
. ~/.enso-complete.zsh
```

#### For Fish
Save the script to `~/.config/fish/completions/enso.fish`:
```fish
_ENSO_COMPLETE=fish_source enso > ~/.config/fish/completions/enso.fish
```
