# 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "syft-installer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "syftbox, installer, federated-learning, privacy",
"author": null,
"author_email": "OpenMined <info@openmined.org>",
"download_url": "https://files.pythonhosted.org/packages/89/0c/c603e253780f5295a791e806fae792c3a19fb1a68db3d3cc7db1f286e925/syft_installer-0.9.1.tar.gz",
"platform": null,
"description": "# syft-installer\n\nA Python API for installing and managing SyftBox\n\n## Installation\n\n```bash\npip install syft-installer\n```\n\n## Quick Start\n\n```python\nimport syft_installer as si\nsi.install_and_run_if_needed()\n```\n\n## Documentation\n\n\ud83d\udcda **[Full Documentation](https://openmined.github.io/syft-installer/)**\n\n- [API Reference](https://openmined.github.io/syft-installer/api/)\n- [Try in Google Colab](https://colab.research.google.com/github/OpenMined/syft-installer/blob/main/examples/syft_install_quickstart.ipynb)\n\n## License\n\nApache 2.0\n\n---\n\nBuilt with \u2764\ufe0f by [OpenMined](https://openmined.org)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python installer for SyftBox - programmatic alternative to the TUI installer",
"version": "0.9.1",
"project_urls": {
"Documentation": "https://github.com/OpenMined/syft-installer#readme",
"Homepage": "https://github.com/OpenMined/syft-installer",
"Issues": "https://github.com/OpenMined/syft-installer/issues",
"Repository": "https://github.com/OpenMined/syft-installer.git"
},
"split_keywords": [
"syftbox",
" installer",
" federated-learning",
" privacy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eb04eeb92f4e5412850ce6420331a582b7e4a131814ba7f43c2845386740ec18",
"md5": "47776eb0299090d2ab96156bc5b10478",
"sha256": "6c20fbba595f942deab2769cc1f1e20402e665142244f7e4478e759ca3c9e72e"
},
"downloads": -1,
"filename": "syft_installer-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47776eb0299090d2ab96156bc5b10478",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27206,
"upload_time": "2025-07-22T05:48:25",
"upload_time_iso_8601": "2025-07-22T05:48:25.351274Z",
"url": "https://files.pythonhosted.org/packages/eb/04/eeb92f4e5412850ce6420331a582b7e4a131814ba7f43c2845386740ec18/syft_installer-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "890cc603e253780f5295a791e806fae792c3a19fb1a68db3d3cc7db1f286e925",
"md5": "47839560e8bf6dd7afd419977707a4bf",
"sha256": "0af4ca84025afe9e39001fad807cacd318bf83e0a61ddc66b3ec2eb6462d7e1e"
},
"downloads": -1,
"filename": "syft_installer-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "47839560e8bf6dd7afd419977707a4bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 28456,
"upload_time": "2025-07-22T05:48:26",
"upload_time_iso_8601": "2025-07-22T05:48:26.669282Z",
"url": "https://files.pythonhosted.org/packages/89/0c/c603e253780f5295a791e806fae792c3a19fb1a68db3d3cc7db1f286e925/syft_installer-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 05:48:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenMined",
"github_project": "syft-installer#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "syft-installer"
}
JSON
