base1000 0.1.0

A a text encoder based on the "Thousand Character Classic"
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# Base1000 Thousand Character Classic Encoder

Base1000 is a text encoder based on the "Thousand Character Classic", supporting encoding any text into a sequence of "Thousand Character Classic" characters and decoding it back to the original text.

## Features

- **Encoding**: Encode input text into a sequence of "Thousand Character Classic" characters.
- **Decoding**: Decode a sequence of "Thousand Character Classic" characters back to the original text.
- **Python Extension Module**: Provides a Python interface for direct usage in Python.
- **Command Line Tool**: Offers a simple and easy-to-use CLI tool.

## Installation

### Build with Cargo
Default enabled features (`clap`, `encode`, `decode`)

```bash
cargo build --release
```

#### Enable Features

- **`clap`**: Enables command-line tool functionality. Enable it with the following command:
  ```bash
  cargo build --release --features clap
  ```

- **`pyo3`**: Enables building the Python extension module. Enable it with the following command:
  ```bash
  cargo build --release --features pyo3
  ```

- **`encode`**: Enables text encoding functionality. Enable it with the following command:
  ```bash
  cargo build --release --features encode
  ```

- **`decode`**: Enables text decoding functionality. Enable it with the following command:
  ```bash
  cargo build --release --features decode
  ```

- Enable multiple features simultaneously:
  ```bash
  cargo build --release --features "clap pyo3 encode decode"
  ```

### Build Python Extension with Maturin

```bash
maturin build --release
```

## Usage

### Command Line Tool

#### Encoding

```bash
base1000 -e "114514"
```

#### Decoding

```bash
base1000 -d "夜裳移柰梧"
```

### Python Extension

#### Installation

```bash
pip install .
```

#### Example

```python
from base1000 import base1000

# Encoding
encoded = base1000.encode("114514")
print(encoded)

# Decoding
decoded = base1000.decode(encoded)
print(decoded)
```

## Testing

Run unit tests:

```bash
cargo test
```

## Project Structure

- `src/lib.rs`: Core library implementation.
- `src/main.rs`: Command-line tool entry point.
- `base1000/__main__.py`: Python CLI implementation.
- `base1000/base1000.pyi`: Python type hint file.