docs

PyFAEST Documentation

Complete documentation for the PyFAEST Python wrapper for FAEST post-quantum signatures.

---

📚 Documentation Index

For Users

Getting Started - Installation and usage guide

• Quick install from PyPI
• Development installation options
• WSL setup for Windows users
• Basic usage examples
• Troubleshooting common issues

For Developers

Developer Guide - Architecture and contribution guide

• Project structure
• Code architecture
• CFFI bindings
• Testing guidelines
• Contributing workflow

For Maintainers

Maintainer Guide - Release and publishing process

• Version management
• Updating bundled libraries
• Publishing to PyPI
• Release checklist
• Multi-platform support

---

Quick Links

• Main README: ../README.md - Complete API reference
• Changelog: ../CHANGELOG.md - Version history
• Examples: ../examples/ - Usage examples
• Tests: ../tests/ - Test suite

---

Documentation Structure

docs/
├── README.md              # This file - documentation index
├── GETTING_STARTED.md     # Installation and usage (users)
├── DEVELOPER_GUIDE.md     # Architecture and contributing (developers)
└── MAINTAINER_GUIDE.md    # Publishing and releases (maintainers)

---

Support

• GitHub Issues: https://github.com/Shreyas582/pyfaest/issues
• FAEST Specification: https://faest.info/
• NIST PQC Project: https://csrc.nist.gov/projects/post-quantum-cryptography