Metadata-Version: 2.1
Name: norman-dp
Version: 0.1.1
Summary: Python frontend for the Norman dataplane.
Home-page: https://github.com/hsadok/norman/frontend
Author: Hugo Sadok
Author-email: sadok@cmu.edu
License: BSD
Download-URL: https://github.com/hsadok/norman
Keywords: network,norman,dataplane
Platform: UNKNOWN
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.6
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: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: click (>=8.0)
Requires-Dist: netexp (==0.1.8)
Requires-Dist: tqdm

# Norman Python Frontend

## Install

To install the frontend run in the current directory (`frontend`):
```bash
pip3 install -e .
```
To run Norman pktgen 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
norman --help
```

## Enable autocompletion (optional)

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

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

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

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

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


