enigma-cipher

Name	enigma-cipher JSON
Version	1.0.0 JSON
	download
home_page	https://github.com/Jtachan/enigma_cipher.git
Summary	Package providing encoder and decoder instances to use the enigma machine cipher
upload_time	2023-08-28 17:24:33
maintainer
docs_url	None
author	Jaime Gonzalez Gomez
requires_python	>=3.8
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ![tests_badge](https://github.com/Jtachan/enigma_cipher/actions/workflows/unittests.yml/badge.svg)
![docs_badge](https://github.com/Jtachan/enigma_cipher/actions/workflows/docs.yml/badge.svg)

# Enigma Cipher

The `Enigma Cipher` is a package that allows ciphering texts as an enigma machine would.

It is referred to 'cipher' the text instead of encoding/decoding, as any text can be encoded or decoded bz ciphering it with a machine with the same configuration.
For example, if the text `VLGBR OYWVV!` is ciphered through a machine with the correct configuration, the outcome will be `HELLO WORLD!`

## 📖 Documentation

You can find the documentation:

- Within the [`/docs`](docs/index.md) folder
- At the [mkdocs generated page](https://jtachan.github.io/enigma_cipher/) (official documentation)

## 🐍 Python Setup

**Requirements**

- Python 3.8 or higher

**Installation**

Use pip with the git link to the repo:
````commandline
pip install git+https://github.com/Jtachan/enigma_cipher.git
````

The 'develop' branch can also be installed to work with unreleased features:
````commandline
pip install git+https://github.com/Jtachan/enigma_cipher.git@develop
````


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Jtachan/enigma_cipher.git",
    "name": "enigma-cipher",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jaime Gonzalez Gomez",
    "author_email": "jim.gomez.dnn@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9c/f0/bb3bb3f5dca864a1e78a395fa0510acaa1e39b22475e71ba6d9c39f390c8/enigma-cipher-1.0.0.tar.gz",
    "platform": null,
    "description": "![tests_badge](https://github.com/Jtachan/enigma_cipher/actions/workflows/unittests.yml/badge.svg)\n![docs_badge](https://github.com/Jtachan/enigma_cipher/actions/workflows/docs.yml/badge.svg)\n\n# Enigma Cipher\n\nThe `Enigma Cipher` is a package that allows ciphering texts as an enigma machine would.\n\nIt is referred to 'cipher' the text instead of encoding/decoding, as any text can be encoded or decoded bz ciphering it with a machine with the same configuration.\nFor example, if the text `VLGBR OYWVV!` is ciphered through a machine with the correct configuration, the outcome will be `HELLO WORLD!`\n\n## \ud83d\udcd6 Documentation\n\nYou can find the documentation:\n\n- Within the [`/docs`](docs/index.md) folder\n- At the [mkdocs generated page](https://jtachan.github.io/enigma_cipher/) (official documentation)\n\n## \ud83d\udc0d Python Setup\n\n**Requirements**\n\n- Python 3.8 or higher\n\n**Installation**\n\nUse pip with the git link to the repo:\n````commandline\npip install git+https://github.com/Jtachan/enigma_cipher.git\n````\n\nThe 'develop' branch can also be installed to work with unreleased features:\n````commandline\npip install git+https://github.com/Jtachan/enigma_cipher.git@develop\n````\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Package providing encoder and decoder instances to use the enigma machine cipher",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/Jtachan/enigma_cipher.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a9a58dd8228de2763ba7ab96c5cfbe15e44e5d93086ca7dd75ab94558c26125a",
                "md5": "b9da34ed2707615405afa61776c84673",
                "sha256": "ac6bd91eb8882efdc2d034409d672baae1d28984577ea45d739638dc56fc530d"
            },
            "downloads": -1,
            "filename": "enigma_cipher-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b9da34ed2707615405afa61776c84673",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9658,
            "upload_time": "2023-08-28T17:24:32",
            "upload_time_iso_8601": "2023-08-28T17:24:32.410559Z",
            "url": "https://files.pythonhosted.org/packages/a9/a5/8dd8228de2763ba7ab96c5cfbe15e44e5d93086ca7dd75ab94558c26125a/enigma_cipher-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9cf0bb3bb3f5dca864a1e78a395fa0510acaa1e39b22475e71ba6d9c39f390c8",
                "md5": "ff1dbab94b7fff21836d1cdf0c82e82b",
                "sha256": "942b61074c744d5c606af175db5ca8820ad3ccfd580bae4943fca032e313d154"
            },
            "downloads": -1,
            "filename": "enigma-cipher-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ff1dbab94b7fff21836d1cdf0c82e82b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8193,
            "upload_time": "2023-08-28T17:24:33",
            "upload_time_iso_8601": "2023-08-28T17:24:33.579636Z",
            "url": "https://files.pythonhosted.org/packages/9c/f0/bb3bb3f5dca864a1e78a395fa0510acaa1e39b22475e71ba6d9c39f390c8/enigma-cipher-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-28 17:24:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Jtachan",
    "github_project": "enigma_cipher",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "enigma-cipher"
}