Metadata-Version: 2.4
Name: neonik
Version: 0.1.88
Summary: The NEONIK runtime library, including NEON and scripts to interact with the backend.
Author: Vincent Ehrmanntraut
Author-email: Vincent Ehrmanntraut <ehrmanntraut@itsec.rwth-aachen.de>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
License-File: NOTICE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Security :: Cryptography
Requires-Dist: aiofiles>=25.1.0
Requires-Dist: aiohttp>=3.13.3
Requires-Dist: fastapi>=0.135.1
Requires-Dist: humanize>=4.15.0
Requires-Dist: psutil>=7.2.2
Requires-Dist: pytz>=2026.1.post1
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: requests>=2.32.5
Requires-Dist: tqdm>=4.67.3
Requires-Dist: uvicorn>=0.42.0
Requires-Dist: zstd==1.5.7.2
Requires-Python: >=3.14
Project-URL: Repository, https://gitlab.com/rwth-itsec/neonik
Project-URL: Issues, https://gitlab.com/rwth-itsec/neonik/-/issues
Description-Content-Type: text/markdown

# neonik

The runtime library of [NEONIK](https://gitlab.com/rwth-itsec/neonik), a framework for running and evaluating
experiments with secure multi-party computation protocols built on NEON and [MP-SPDZ](https://github.com/data61/MP-SPDZ).

It contains NEON and the scripts executed in experiment jobs and used to interact with the NEONIK backend:

| Script                | Description                                         |
|-----------------------|-----------------------------------------------------|
| `neonik-setup`        | Installs MP-SPDZ.                                   |
| `push-experiments`    | Uploads experiments to the backend.                 |
| `pull-reports`        | Downloads computation reports from the backend.     |
| `run-all-experiments` | Runs the experiments of a project locally.          |

See the [repository](https://gitlab.com/rwth-itsec/neonik) for documentation.

## License

GNU General Public License v3.0 or later, see [LICENSE](LICENSE) and [NOTICE](NOTICE).
