Metadata-Version: 2.4
Name: flow-narrator
Version: 0.1.1
Summary: Generate natural sentences describing network flows
Project-URL: Homepage, https://github.com/carmine-ambrosino/flow-narrator
Project-URL: Repository, https://github.com/carmine-ambrosino/flow-narrator.git
Project-URL: Issue Tracker, https://github.com/carmine-ambrosino/flow-narrator/issues
Author-email: Carmine Ambrosino <flownarrator@proton.me>
License: MPL-2.0
License-File: LICENSE
Keywords: flows,logging,narration,network
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Networking
Requires-Python: >=3.9
Requires-Dist: pandas>=2.3.3
Requires-Dist: tqdm>=4.67.1
Provides-Extra: dev
Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
Requires-Dist: pytest>=8.4.2; extra == 'dev'
Requires-Dist: ruff>=0.14.2; extra == 'dev'
Description-Content-Type: text/markdown

# 📦 flow-narrator
A Python library to automatically generate natural-language sentences that describe network flows.

🔗 **Source code:** https://github.com/carmine-ambrosino/flow-narrator

## Installation
``` bash
pip install flow-narrator
```

## Quickstart
``` python
import flownarrator as fn

out = fn.generate_sentences(
    "<YOUR DATASETS>",
    max_items=10,
    balance=True,
    show_progress=True,
)

# Save to CSV
out.to_csv("example_sentences.csv", index=False)
```

## Convert to Alpaca format
``` python
import flownarrator as fn

out = pd.read_csv(<YOUR CSV>)
alpaca = fn.to_alpaca_format(out)

# Preview of Alpaca-formatted data
print("\n📐 Alpaca-style first item preview:")
print(alpaca[0])
```