Metadata-Version: 2.4
Name: syft-installer
Version: 0.9.1
Summary: Python installer for SyftBox - programmatic alternative to the TUI installer
Author-email: OpenMined <info@openmined.org>
License: Apache-2.0
Project-URL: Homepage, https://github.com/OpenMined/syft-installer
Project-URL: Documentation, https://github.com/OpenMined/syft-installer#readme
Project-URL: Repository, https://github.com/OpenMined/syft-installer.git
Project-URL: Issues, https://github.com/OpenMined/syft-installer/issues
Keywords: syftbox,installer,federated-learning,privacy
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0
Requires-Dist: rich>=13.0.0
Requires-Dist: PyJWT>=2.8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Dynamic: license-file

# syft-installer

A Python API for installing and managing SyftBox

## Installation

```bash
pip install syft-installer
```

## Quick Start

```python
import syft_installer as si
si.install_and_run_if_needed()
```

## Documentation

📚 **[Full Documentation](https://openmined.github.io/syft-installer/)**

- [API Reference](https://openmined.github.io/syft-installer/api/)
- [Try in Google Colab](https://colab.research.google.com/github/OpenMined/syft-installer/blob/main/examples/syft_install_quickstart.ipynb)

## License

Apache 2.0

---

Built with ❤️ by [OpenMined](https://openmined.org)
