ddcCryptography


NameddcCryptography JSON
Version 1.0.5 PyPI version JSON
download
home_pagehttps://github.com/ddc/ddcCryptography
SummaryEncode and Decode Strings
upload_time2024-10-17 18:02:41
maintainerDaniel Costa
docs_urlNone
authorDaniel Costa
requires_python<4.0,>=3.10
licenseMIT
keywords python3 cryptography ddccryptography encode decode
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Few Utility Functions

[![License](https://img.shields.io/github/license/ddc/ddcCryptography.svg?style=plastic)](https://github.com/ddc/ddcCryptography/blob/master/LICENSE)
[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg?style=plastic)](https://www.python.org)
[![PyPi](https://img.shields.io/pypi/v/ddcCryptography.svg?style=plastic)](https://pypi.python.org/pypi/ddcCryptography)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A//actions-badge.atrox.dev/ddc/ddcCryptography/badge?ref=main&style=plastic&label=build&logo=none)](https://actions-badge.atrox.dev/ddc/ddcCryptography/goto?ref=main)


# Install
```shell
pip install ddcCryptography
```

# Cryptography
```python
from ddcCryptography import Cryptography
cp = Cryptography()
```

+ GENERATE_PRIVATE_KEY
    + Generates a private key to be used instead of default one
    + But keep in mind that this private key will be needed to decode further strings
        ```
        @staticmethod
        cp.generate_private_key() -> str
        ```

+ ENCODE
    + Encodes a given string
        ```
        cp.encode(str_to_encode: str) -> str
         ```     

+ DECODE
    + Decodes a given string
        ```
        cp.decode(str_to_decode: str) -> str
        ```


# Source Code
### Build
```shell
poetry build
```


### Run Tests
```shell
poetry run coverage run -m pytest -v
```


### Get Coverage Report
```shell
poetry run coverage report
```


# License
Released under the [MIT License](LICENSE)


## Buy me a cup of coffee
I know there are people out there that may want to donate just to show their appreciation. Thanks in advance!

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?business=MRJ2NVUGSK4EA&no_recurring=0&item_name=ddcCryptography&currency_code=USD)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ddc/ddcCryptography",
    "name": "ddcCryptography",
    "maintainer": "Daniel Costa",
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "python3, Cryptography, ddcCryptography, encode, decode",
    "author": "Daniel Costa",
    "author_email": "danieldcsta@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bf/7c/e33f26e1c337ac4ab766f5424a4f6df886624c15a83eeca5981ef5abd823/ddccryptography-1.0.5.tar.gz",
    "platform": null,
    "description": "# Few Utility Functions\n\n[![License](https://img.shields.io/github/license/ddc/ddcCryptography.svg?style=plastic)](https://github.com/ddc/ddcCryptography/blob/master/LICENSE)\n[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg?style=plastic)](https://www.python.org)\n[![PyPi](https://img.shields.io/pypi/v/ddcCryptography.svg?style=plastic)](https://pypi.python.org/pypi/ddcCryptography)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A//actions-badge.atrox.dev/ddc/ddcCryptography/badge?ref=main&style=plastic&label=build&logo=none)](https://actions-badge.atrox.dev/ddc/ddcCryptography/goto?ref=main)\n\n\n# Install\n```shell\npip install ddcCryptography\n```\n\n# Cryptography\n```python\nfrom ddcCryptography import Cryptography\ncp = Cryptography()\n```\n\n+ GENERATE_PRIVATE_KEY\n    + Generates a private key to be used instead of default one\n    + But keep in mind that this private key will be needed to decode further strings\n        ```\n        @staticmethod\n        cp.generate_private_key() -> str\n        ```\n\n+ ENCODE\n    + Encodes a given string\n        ```\n        cp.encode(str_to_encode: str) -> str\n         ```     \n\n+ DECODE\n    + Decodes a given string\n        ```\n        cp.decode(str_to_decode: str) -> str\n        ```\n\n\n# Source Code\n### Build\n```shell\npoetry build\n```\n\n\n### Run Tests\n```shell\npoetry run coverage run -m pytest -v\n```\n\n\n### Get Coverage Report\n```shell\npoetry run coverage report\n```\n\n\n# License\nReleased under the [MIT License](LICENSE)\n\n\n## Buy me a cup of coffee\nI know there are people out there that may want to donate just to show their appreciation. Thanks in advance!\n\n[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?business=MRJ2NVUGSK4EA&no_recurring=0&item_name=ddcCryptography&currency_code=USD)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Encode and Decode Strings",
    "version": "1.0.5",
    "project_urls": {
        "Homepage": "https://github.com/ddc/ddcCryptography",
        "Repository": "https://github.com/ddc/ddcCryptography"
    },
    "split_keywords": [
        "python3",
        " cryptography",
        " ddccryptography",
        " encode",
        " decode"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "691090da80089ba67636ddcff9d6b021bec999a6fc81f484fd328e32a09c7020",
                "md5": "ae9b25a05135cba2eacaeac9b8cedc42",
                "sha256": "dc6720473d0feb7e4a90a4cf49170547abe9b18952bb155c66f1d13bce2cc18e"
            },
            "downloads": -1,
            "filename": "ddccryptography-1.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ae9b25a05135cba2eacaeac9b8cedc42",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 4266,
            "upload_time": "2024-10-17T18:02:40",
            "upload_time_iso_8601": "2024-10-17T18:02:40.548199Z",
            "url": "https://files.pythonhosted.org/packages/69/10/90da80089ba67636ddcff9d6b021bec999a6fc81f484fd328e32a09c7020/ddccryptography-1.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf7ce33f26e1c337ac4ab766f5424a4f6df886624c15a83eeca5981ef5abd823",
                "md5": "acccb94af08eae4131fd25ed5acd9e1b",
                "sha256": "86b1eaa6c6303549aa4ec460a5b6aa86af1a69597a8f0f4317af3165c0f60f9c"
            },
            "downloads": -1,
            "filename": "ddccryptography-1.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "acccb94af08eae4131fd25ed5acd9e1b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 3555,
            "upload_time": "2024-10-17T18:02:41",
            "upload_time_iso_8601": "2024-10-17T18:02:41.898292Z",
            "url": "https://files.pythonhosted.org/packages/bf/7c/e33f26e1c337ac4ab766f5424a4f6df886624c15a83eeca5981ef5abd823/ddccryptography-1.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-17 18:02:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ddc",
    "github_project": "ddcCryptography",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ddccryptography"
}
        
Elapsed time: 0.35630s