Metadata-Version: 2.4
Name: istorable
Version: 1.0.2
Summary: A lightweight Python library for creating password-protected vaults and storing data inside them.
Author: Parsa Sh
License: MIT License
        
        Copyright (c) 2026 Parsa Sh
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: termcolor
Dynamic: license-file

# STORABLE

**STORABLE** is a lightweight Python library for creating password-protected vaults and storing data inside them.

## Installation

```bash
pip install istorable==1.0.2
```

## v1.0.2 Updates

### 🙌 Fixed Import Bugs

In previous versions, the recommended import could cause errors:

```python
import Storable
```

In v1.0.2:

```python
import Storable.iStorable as Storable
```

---

### 👨‍💻 Updated Help System

The built-in:

```python
Storable.Help.show()
```

system has been redesigned to provide more useful information to developers.

Previously, it only displayed function names:

```text
PSS()
add_data()
```

Now, it explains what the functions do and how they should be used:

```text
PSS()
    -> PSS is the main part of the library and needs to be assigned to a variable.

add_data(data)
    -> Adds data into your Main-Vault.
       The Main-Vault is your general vault and can be accessed
       without a password.
```

> ⚠️ **UNFINISHED:** The `Storable.Help.show()` update is still being worked on and may change before a future release.

---

### 🌐 `Help.web()`

A web-based documentation system is planned for STORABLE.

The goal is to allow developers to open the STORABLE documentation directly from Python:

```python
Storable.Help.web()
```
<br>

---

## Quick Start

```python
import Storable.iStorable as Storable

vault = Storable.ClientVault("test", "1234")

vault.store("data", "hello world")
```

> **Note:** The import path is currently `Storable.iStorable`. This is the supported import path for v1.0.2.

## Features

* 🔐 Password-protected vaults
* 💾 Local JSON data storage
* 🔑 Custom data encryption
* 🗄️ Multiple vaults
* 🛠️ Built-in help system
* 🐍 Simple Python API

## Help

STORABLE includes a built-in help system:

```python
import Storable.iStorable as Storable

Storable.Help.show()
```

The help system is designed to explain the available functionality and how developers can use it.

A web-based help system is planned:

```python
Storable.Help.web()
```

**Status:** Unfinished

## Version

**v1.0.2**

## License

STORABLE is licensed under the **MIT License**.

See the `LICENSE` file for the full license text.

---

Made by **Parsa Sh** (GitHub).
