<div align="center">
# diec
[](https://github.com/D-I-Projects/diec#license) [](https://pypi.org/project/diec/) <a href="https://github.com/D-I-Projects/diec/blob/master/CONTRIBUTING.md"><img src="https://img.shields.io/github/contributors-anon/D-I-Projects/diec" alt="Contributors badge" /></a> 
```pip install diec```
</div>
A tool that encodes text and gives out a key that you can decode with this program too!
Our official test UI : [diec-test-gui](https://github.com/D-I-Projects/diec-test-gui)
## Installation
```bash
pip install diec
```
# Example
<hr>
## encode()
```python
from diec.encoder import encode
encode("I love python and I love to learn new things here too! <3")
```
### Output
The Key you created : <a href="https://github.com/D-I-Projects/diec/blob/main/diec_example/key.diec">key.diec</a>
The encoded text : <a href="https://github.com/D-I-Projects/diec/blob/main/diec_example/encoded.diec">encoded.diec</a>
**Both of them will appear in your current directory**
<hr>
## decode()
```python
from diec.decoder import decode
decode() # The key.diec and encoded.diec files have to be in the same directory as the file that runs this command.
```
### Output
```bash
I love python and I love to learn new things here too! <3
```
<hr>
## CLI Tutorial
The Diec CLI (Command Line Interface) allows you to easily encode and decode text via the terminal.
### Installation
Make sure Diec is installed:
```bash
pip install diec
```
### Using the CLI
After installation, you can use the following commands:
1. **Encode Text**:
To encode a text, use the `encode_cli` command. Provide the desired text in quotes:
```bash
python -m diec encode-cli "Your text here"
```
**Example**:
```bash
python -m diec encode-cli "I love Python and learning new things! <3"
```
After running this command, a key file (`key.diec`) and an encoded file (`encoded.diec`) will be created in your current directory.
2. **Decode Text**:
To decode an encoded text, use the `decode_cli` command:
```bash
python -m diec decode-cli
```
Make sure that the `key.diec` and `encoded.diec` files are in the same directory as the script you run.
---
Raw data
{
"_id": null,
"home_page": "https://github.com/d-i-projects/diec",
"name": "diec",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "diec, encoding, decoding",
"author": "D&I",
"author_email": "di.projects.help@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d1/21/47f2b31d4f43f85a72650872c1e12cc4df7a9cd5ec9aac4c8cd003450f4e/diec-1.9.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n \n# diec\n\n[](https://github.com/D-I-Projects/diec#license) [](https://pypi.org/project/diec/) <a href=\"https://github.com/D-I-Projects/diec/blob/master/CONTRIBUTING.md\"><img src=\"https://img.shields.io/github/contributors-anon/D-I-Projects/diec\" alt=\"Contributors badge\" /></a> \n\n```pip install diec``` \n\n</div>\n\nA tool that encodes text and gives out a key that you can decode with this program too!\n\nOur official test UI : [diec-test-gui](https://github.com/D-I-Projects/diec-test-gui)\n\n## Installation\n\n```bash\npip install diec\n```\n\n# Example\n\n<hr>\n\n## encode()\n\n```python\nfrom diec.encoder import encode\n\nencode(\"I love python and I love to learn new things here too! <3\")\n```\n### Output\n\nThe Key you created : <a href=\"https://github.com/D-I-Projects/diec/blob/main/diec_example/key.diec\">key.diec</a>\n\nThe encoded text : <a href=\"https://github.com/D-I-Projects/diec/blob/main/diec_example/encoded.diec\">encoded.diec</a>\n\n**Both of them will appear in your current directory**\n\n<hr>\n\n## decode()\n\n```python\nfrom diec.decoder import decode\n\ndecode() # The key.diec and encoded.diec files have to be in the same directory as the file that runs this command.\n```\n### Output\n```bash\nI love python and I love to learn new things here too! <3\n```\n<hr>\n\n## CLI Tutorial\n\nThe Diec CLI (Command Line Interface) allows you to easily encode and decode text via the terminal.\n\n### Installation\n\nMake sure Diec is installed:\n\n```bash\npip install diec\n```\n\n### Using the CLI\n\nAfter installation, you can use the following commands:\n\n1. **Encode Text**:\n\n To encode a text, use the `encode_cli` command. Provide the desired text in quotes:\n\n ```bash\n python -m diec encode-cli \"Your text here\"\n ```\n\n **Example**:\n\n ```bash\n python -m diec encode-cli \"I love Python and learning new things! <3\"\n ```\n\n After running this command, a key file (`key.diec`) and an encoded file (`encoded.diec`) will be created in your current directory.\n\n2. **Decode Text**:\n\n To decode an encoded text, use the `decode_cli` command:\n\n ```bash\n python -m diec decode-cli\n ```\n\n Make sure that the `key.diec` and `encoded.diec` files are in the same directory as the script you run.\n\n---\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool that encodes text and provides a key for decoding!",
"version": "1.9",
"project_urls": {
"Download": "https://github.com/D-I-Projects/diec/archive/refs/tags/v1.9.tar.gz",
"Homepage": "https://github.com/d-i-projects/diec"
},
"split_keywords": [
"diec",
" encoding",
" decoding"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b8b5cb160e5e58a63fc9aea4343da7a1f0ad12405dc64bfef282b0ec5f716df",
"md5": "2879a4670c02e3b6b40b5bb9f6d509a1",
"sha256": "f47344be74e10a845b05492ad94cdadc0fbd4c523238fcf6fb908ba058d84c15"
},
"downloads": -1,
"filename": "diec-1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2879a4670c02e3b6b40b5bb9f6d509a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5169,
"upload_time": "2024-08-17T19:20:22",
"upload_time_iso_8601": "2024-08-17T19:20:22.168814Z",
"url": "https://files.pythonhosted.org/packages/5b/8b/5cb160e5e58a63fc9aea4343da7a1f0ad12405dc64bfef282b0ec5f716df/diec-1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d12147f2b31d4f43f85a72650872c1e12cc4df7a9cd5ec9aac4c8cd003450f4e",
"md5": "aaa853316c01c7ac4a512cf6b97afd79",
"sha256": "fe2943aa95f355fb14832eb654a59a4a66a15e8709928538872146109dc5286a"
},
"downloads": -1,
"filename": "diec-1.9.tar.gz",
"has_sig": false,
"md5_digest": "aaa853316c01c7ac4a512cf6b97afd79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4217,
"upload_time": "2024-08-17T19:20:23",
"upload_time_iso_8601": "2024-08-17T19:20:23.513260Z",
"url": "https://files.pythonhosted.org/packages/d1/21/47f2b31d4f43f85a72650872c1e12cc4df7a9cd5ec9aac4c8cd003450f4e/diec-1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-17 19:20:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "d-i-projects",
"github_project": "diec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "binaryconvert",
"specs": []
}
],
"lcname": "diec"
}
JSON
