cryptrooper


Namecryptrooper JSON
Version 0.1 PyPI version JSON
download
home_pagehttps://github.com/sprin-g-reen/cryptrooper
SummaryA module to encode and decode your text with a key
upload_time2021-06-11 08:37:26
maintainer
docs_urlNone
authorParvat
requires_python>=3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Cryptrooper

A module that can endode and decode your text with your given key.


| ![LICENSE](https://img.shields.io/badge/License-Mozilla%20Public%20License%202.0-green.svg)| ![Tests](https://img.shields.io/badge/Tests-Passing-blue.svg) |
| :----- | :----- |
| ![Builds](https://img.shields.io/badge/Builds-Passing-blue.svg) | ![Maintainer](https://img.shields.io/badge/Maintainer-Parvat-black.svg) |

## Features

- No additinal installation required.
- Can work on any system with python >= 3.8
- Can encode and decode text of any language.
- Can encode and decode emoticons and symbols also.
## Installation 

Install cryptrooper with git-clone

```bash 
  git clone https://github.com/sprin-g-reen/cryptrooper
  cd cryptrooper
```
## Documentation

Install the cryptrooper in your working directory.
`Crypto` is a class in the `__init__.py` file at the directory `cryptrooper`.

#### Parameters:
- text 
    - The text you want to encode or decode.
- key
    - The key to encode or decode the text with.
#### Functions:
- encode
    - The function that encodes your text with your key.
    - returns a `DICT` like the below one:
        ```json
        {  
            "key": "Your Key",
            "encoded": "The encoded text",
            "decoded": "The decoded text",
            "result": "The encoded text",
            "error": None
        }
        ```
        - The error is None if no error, else it contains the class of raised error.

- decode
    - The function that decoded your encoded text with your key.
    - returns a `DICT` like the below one:
        ```json
        {  
            "key": "Your Key",
            "encoded": "The encoded text",
            "decoded": "The decoded text",
            "result": "The decoded text",
            "error": None
        }
        ```
        - The error is None if no error, else it contains the class of raised error.



Example of encoding:
```python
from cryptrooper import Crypto

# `Crypto` is a class.
text = "The text you want to encode."
key = "The key."


# passing the text and key to Crypto
ins = Crypto(text, key)


# getting the result which is of type `dict`
result = ins.encode()
print(result)


# this prints:
# {
#     'key': 'The key.',
#     'encoded': '168 208 202 64 223 202 241 200 \136 222 143 224 133 240 181 214 217 64 223 212 153 185 214 200 143 207 202 167',
#     'decoded': 'The text you want to encode.',
#     'result': '168 208 202 64 223 202 241 200 136 222 143 224 133 240 181 214 217 64 223 212 153 185 214 200 143 207 202 167',
#     'error': None
# }
```


Example of decoding:
```python
from cryptrooper import Crypto


# `Crypto` is a class.
text = "183 212 212 149 214 215 232 149 204 223 143 215 207 225 212 163"
key = "cloud"


# passing the text and key to Crypto
ins = Crypto(text, key)


# getting the result which is of type `dict`
result = ins.decode()
print(result)


# this prints:
# {
#     'key': 'cloud',
#     'encode': '183 212 212 149 214 215 232 149 204 223 143 215 207 225 212 163',
#     'decode': 'The sky is blue.',
#     'result': 'The sky is blue.',
#     'error': None
# }
```
## Authors

- [@Parvat-web-dev](https://www.github.com/Parvat-web-dev)
- [@Rohithsreedharan](https://www.github.com/Rohithsreedharan)

  

## Contributing

Contributions are always welcome!
Contact [*@Parvat_R*](https://telegram.me/Parvat_R) for Contributions.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sprin-g-reen/cryptrooper",
    "name": "cryptrooper",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Parvat",
    "author_email": "replyerrors.parvat@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/20/3b/c1d9311ea4759dad1a0601adc2f6120c52367060f2aa334bc97d16388c74/cryptrooper-0.1.tar.gz",
    "platform": "",
    "description": "\n# Cryptrooper\n\nA module that can endode and decode your text with your given key.\n\n\n| ![LICENSE](https://img.shields.io/badge/License-Mozilla%20Public%20License%202.0-green.svg)| ![Tests](https://img.shields.io/badge/Tests-Passing-blue.svg) |\n| :----- | :----- |\n| ![Builds](https://img.shields.io/badge/Builds-Passing-blue.svg) | ![Maintainer](https://img.shields.io/badge/Maintainer-Parvat-black.svg) |\n\n## Features\n\n- No additinal installation required.\n- Can work on any system with python >= 3.8\n- Can encode and decode text of any language.\n- Can encode and decode emoticons and symbols also.\n## Installation \n\nInstall cryptrooper with git-clone\n\n```bash \n  git clone https://github.com/sprin-g-reen/cryptrooper\n  cd cryptrooper\n```\n## Documentation\n\nInstall the cryptrooper in your working directory.\n`Crypto` is a class in the `__init__.py` file at the directory `cryptrooper`.\n\n#### Parameters:\n- text \n    - The text you want to encode or decode.\n- key\n    - The key to encode or decode the text with.\n#### Functions:\n- encode\n    - The function that encodes your text with your key.\n    - returns a `DICT` like the below one:\n        ```json\n        {  \n            \"key\": \"Your Key\",\n            \"encoded\": \"The encoded text\",\n            \"decoded\": \"The decoded text\",\n            \"result\": \"The encoded text\",\n            \"error\": None\n        }\n        ```\n        - The error is None if no error, else it contains the class of raised error.\n\n- decode\n    - The function that decoded your encoded text with your key.\n    - returns a `DICT` like the below one:\n        ```json\n        {  \n            \"key\": \"Your Key\",\n            \"encoded\": \"The encoded text\",\n            \"decoded\": \"The decoded text\",\n            \"result\": \"The decoded text\",\n            \"error\": None\n        }\n        ```\n        - The error is None if no error, else it contains the class of raised error.\n\n\n\nExample of encoding:\n```python\nfrom cryptrooper import Crypto\n\n# `Crypto` is a class.\ntext = \"The text you want to encode.\"\nkey = \"The key.\"\n\n\n# passing the text and key to Crypto\nins = Crypto(text, key)\n\n\n# getting the result which is of type `dict`\nresult = ins.encode()\nprint(result)\n\n\n# this prints:\n# {\n#     'key': 'The key.',\n#     'encoded': '168 208 202 64 223 202 241 200 \\136 222 143 224 133 240 181 214 217 64 223 212 153 185 214 200 143 207 202 167',\n#     'decoded': 'The text you want to encode.',\n#     'result': '168 208 202 64 223 202 241 200 136 222 143 224 133 240 181 214 217 64 223 212 153 185 214 200 143 207 202 167',\n#     'error': None\n# }\n```\n\n\nExample of decoding:\n```python\nfrom cryptrooper import Crypto\n\n\n# `Crypto` is a class.\ntext = \"183 212 212 149 214 215 232 149 204 223 143 215 207 225 212 163\"\nkey = \"cloud\"\n\n\n# passing the text and key to Crypto\nins = Crypto(text, key)\n\n\n# getting the result which is of type `dict`\nresult = ins.decode()\nprint(result)\n\n\n# this prints:\n# {\n#     'key': 'cloud',\n#     'encode': '183 212 212 149 214 215 232 149 204 223 143 215 207 225 212 163',\n#     'decode': 'The sky is blue.',\n#     'result': 'The sky is blue.',\n#     'error': None\n# }\n```\n## Authors\n\n- [@Parvat-web-dev](https://www.github.com/Parvat-web-dev)\n- [@Rohithsreedharan](https://www.github.com/Rohithsreedharan)\n\n  \n\n## Contributing\n\nContributions are always welcome!\nContact [*@Parvat_R*](https://telegram.me/Parvat_R) for Contributions.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A module to encode and decode your text with a key",
    "version": "0.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "62abf25c228e24242603bbfc859d997d",
                "sha256": "7c2345e971889b739617a2e54ab9849c4647fcfc06b02f51e29b0b0d77e76833"
            },
            "downloads": -1,
            "filename": "cryptrooper-0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "62abf25c228e24242603bbfc859d997d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8527,
            "upload_time": "2021-06-11T08:37:25",
            "upload_time_iso_8601": "2021-06-11T08:37:25.254454Z",
            "url": "https://files.pythonhosted.org/packages/48/5b/19a32165261193566c35ea23679769ebf27e086f157b1fcb8bdac8a32443/cryptrooper-0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ed0518d0f939baa2336372ab2694ed8a",
                "sha256": "0c1621df484abadff883f3f454e5c4abd7a163502f4872d69d09417d46062a38"
            },
            "downloads": -1,
            "filename": "cryptrooper-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ed0518d0f939baa2336372ab2694ed8a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 8312,
            "upload_time": "2021-06-11T08:37:26",
            "upload_time_iso_8601": "2021-06-11T08:37:26.958929Z",
            "url": "https://files.pythonhosted.org/packages/20/3b/c1d9311ea4759dad1a0601adc2f6120c52367060f2aa334bc97d16388c74/cryptrooper-0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-11 08:37:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "sprin-g-reen",
    "error": "Could not fetch GitHub repository",
    "lcname": "cryptrooper"
}
        
Elapsed time: 0.36356s