Metadata-Version: 2.4
Name: flet-secure-storage
Version: 1.0.1
Summary: Secure Storage control for Flet
Author-email: "Appveyor Systems Inc." <hello@flet.dev>
Project-URL: Homepage, https://flet.dev
Project-URL: Documentation, https://flet.dev/docs/services/securestorage
Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-secure-storage
Project-URL: Issues, https://github.com/flet-dev/flet/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flet==1.0.1
Dynamic: license-file

# flet-secure-storage

[![pypi](https://img.shields.io/pypi/v/flet-secure-storage.svg)](https://pypi.python.org/pypi/flet-secure-storage)
[![downloads](https://static.pepy.tech/badge/flet-secure-storage/month)](https://pepy.tech/project/flet-secure-storage)
[![python](https://img.shields.io/badge/python-%3E%3D3.10-%2334D058)](https://pypi.org/project/flet-secure-storage)
[![docstring coverage](https://flet.dev/docs/assets/badges/docs-coverage/flet-secure-storage.svg)](https://flet.dev/docs/assets/badges/docs-coverage/flet-secure-storage.svg)
[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-secure-storage/LICENSE)

A service for safely storing sensitive key–value data using the platform’s native secure storage mechanisms—Keychain on iOS/macOS, Windows Credential Manager, libsecret on Linux, and Keystore on Android.

> **[Try flet-secure-storage in Flet Studio](https://studio.flet.dev/gallery/utility/securestorage/example/extensions/secure_storage/secure_storage)**
>
> Prototype your Flet app interface in the browser, then integrate secure storage in your local project. Write your own Python code or get help from the AI agent.

Powered by Flutter's [`flutter_secure_storage`](https://pub.dev/packages/flutter_secure_storage) package.

You need `libsecret-1-dev` on your machine to build the project, and `libsecret-1-0` to run the application (add it as a dependency after packaging your app). If you using snapcraft to build the project use the following.

Apart from `libsecret` you also need a keyring service, for that you need either [`gnome-keyring`](https://wiki.gnome.org/Projects/GnomeKeyring) (for Gnome users) or [`kwalletmanager`](https://wiki.archlinux.org/title/KDE_Wallet) (for KDE users) or other light provider like [`secret-service`](https://github.com/yousefvand/secret-service).

```bash
sudo apt-get install libsecret-1-dev libsecret-1-0
```

## Documentation

Detailed documentation to this package can be found [here](https://flet.dev/docs/services/securestorage/).

## Platform Support

| Platform | Windows | macOS | Linux | iOS | Android | Web |
|----------|---------|-------|-------|-----|---------|-----|
| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |

## Usage

### Installation

To install the `flet-secure-storage` package and add it to your project dependencies:

- Using `uv`:
    ```bash
    uv add flet-secure-storage
    ```

- Using `pip`:
    ```bash
    pip install flet-secure-storage
    ```
    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.

### Examples

For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/extensions/secure_storage).
