Installation

NoiseFramework requires Python 3.8 or higher. Dependencies are automatically installed via pip.

Recommended

Install from PyPI

The easiest way to install NoiseFramework

pip install noiseframework

View on PyPI

Install from Source

For development or to use the latest unreleased features

git clone https://github.com/juliuspleunes4/noiseframework.gitcd noiseframeworkpip install -e .

View on GitHub

Development Setup

For contributing to NoiseFramework

git clone https://github.com/juliuspleunes4/noiseframework.gitcd noiseframeworkpython -m venv venv# On Linux/macOS: source venv/bin/activate# On Windows: venv\Scripts\activatepip install -e ".[dev]"

Contributing Guide

Requirements

Python 3.8 or higher
cryptography library (automatically installed)
Operating System: Windows, Linux, macOS
Architecture: x86_64, ARM64, ARM

Verify Installation

Verify NoiseFramework is installed correctly

Method 1: Python Import

python -c "from noiseframework import NoiseHandshake; print('NoiseFramework installed successfully!')"

Method 2: CLI Version Check

noiseframework --version

Next Steps

Quick Start Guide

Learn the basics of NoiseFramework in 5 minutes

Get Started

View Examples

Explore real-world code examples and use cases

Browse Examples

API Documentation

Complete API reference for all classes and methods

View API Docs