Metadata-Version: 2.1
Name: lmcmd
Version: 0.1.1
Summary: The Fast lmdb Command Client
Author: Jack.Zhang
Author-email: 17284782591@163.com
Requires-Python: >=3.8,<4.0
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
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: lmdb (>=1.6.2,<2.0.0)
Description-Content-Type: text/markdown

# LMCMD

## Introduction

`lmcmd` is an interactive console based on Python's `code.InteractiveConsole`, supporting key-value database operations using `LMDB`.

## Installation

You can install it using `pip`:

```bash
pip install lmcmd
```

## Features

- **show**: Display the current database name.
- **set `<KEY>` `<VALUE>`**: Store key-value data.
- **get `<KEY>`**: Retrieve the value of a specified key.
- **del `<KEY>`**: Delete a specified key.
- **list**: List all key-value pairs in the database.
- **export**: Export database data to `export.json`.
- **import `<ID>` `<FILE_PATH>`**: Import data from a JSON file.

## Usage

### 1. Start the Terminal

After installation, you can run it directly from the command line:

```bash
lmcmd my_database
```

### 2. Interactive Commands Example

```shell
>>> set name Alice
Ok
>>> get name
Alice
>>> list
{name: Alice}
>>> export
Data Exported to export.json
>>> import id data.json
Data Imported!
>>> show
Database: my_database
>>> del name
Ok
>>> list
(Empty)
```

## Explanation

### **Data Storage**

All data is stored in the `LMDB` database. A `KEY` must be provided for `set/get/del` operations.

### **Data Export**

Use the `export` command to save database data to `export.json`.

### **Data Import**

`import <ID> <FILE_PATH>`

- `<ID>`: The unique identifier field for the imported data.
- `<FILE_PATH>`: The path to the JSON data file.

If the JSON data is formatted as follows:

```json
[
  { "id": 1, "name": "Alice" },
  { "id": 2, "name": "Bob" }
]
```

Executing `import id data.json` will store the data using `id` as the key.

## Dependencies

- Python 3.8+
- `lmdb`

## License

This project is released under the MIT License.

