# Scytale
Just a very simple python script to calculate the scytale-cipher through an cli-wizard.
The projects main purpose is to showcase interesting tooling to build, publish and develop python apps.
## Code Status
[](https://github.com/lockejan/scytale/actions/workflows/branch.yml)
[](https://codecov.io/gh/lockejan/scytale)
Code documentation: https://scytale.readthedocs.io
## Description
The scytale was used more than 2500 years ago by the Spartans, and is one example of ancient cryptography.
A message gets written on a ribbon which is then wrapped around a stick with a certain diameter (the scytale).
Below is a sample encryption of the plain text "prove me wrong!" with a scytale of diameter 3.
We write the message around the scytale, and then
```
|p|r|o|
- - -
|v|e| |
- - -
|m|e| |
- - -
|w|r|o|
- - -
|n|g|!|
```
The cipher text is obtained by reading from top to bottom, left to right.
In this example, the cipher text is
```
pvmwnreergo o!
```
## Setup
### Using Nix
To follow this path at least Nix has to be installed (and flakes have to be enabled).
- `nix develop` will drop you into a shell containing everything to further hack on the project.
Inside the devShell invoking `scytale` should bring up a prompt.
- `nix run` will run the default app of the flake file.
- `nix build` will build the default package with the help of [poetry2nix](https://github.com/nix-community/poetry2nix)
- [default.nix](./default.nix) is included to build the package the non-flake way with `nix-build`.
- [shell.nix](./shell.nix) contains instructions to provide a non-flake shell via `nix-shell`.
### Without Nix
At least Poetry needs to be installed.
- `poetry run scytale` will activate the poetry environment and execute the script held in [pyproject.toml](./pyproject.toml#L3).
If errors are occurring `poetry install` (installs the virtual environment and all given requirements)
- `poetry shell` (activates and enters the virtual environment)
- `poetry run python -m unittest discover` (runs all tests). Alternatively `poetry run python -m pytest tests` to use pytest for test execution.
Raw data
{
"_id": null,
"home_page": "https://github.com/lockejan/scytale",
"name": "scytale-cipher",
"maintainer": "Jan Schmitt",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "git@smittie.de",
"keywords": "scytale,cipher,cli",
"author": "Jan Schmitt",
"author_email": "git@smittie.de",
"download_url": "https://files.pythonhosted.org/packages/f0/6b/4b81e37f02953007a18a017b94cb76eeeaec35164d2a8b24514267e27aaa/scytale_cipher-0.1.2.tar.gz",
"platform": null,
"description": "# Scytale\n\nJust a very simple python script to calculate the scytale-cipher through an cli-wizard.\n\nThe projects main purpose is to showcase interesting tooling to build, publish and develop python apps.\n\n## Code Status\n\n[](https://github.com/lockejan/scytale/actions/workflows/branch.yml)\n[](https://codecov.io/gh/lockejan/scytale)\n\nCode documentation: https://scytale.readthedocs.io\n\n## Description\n\nThe scytale was used more than 2500 years ago by the Spartans, and is one example of ancient cryptography.\nA message gets written on a ribbon which is then wrapped around a stick with a certain diameter (the scytale).\n\nBelow is a sample encryption of the plain text \"prove me wrong!\" with a scytale of diameter 3.\nWe write the message around the scytale, and then\n\n```\n|p|r|o|\n - - -\n|v|e| |\n - - -\n|m|e| |\n - - -\n|w|r|o|\n - - -\n|n|g|!|\n```\n\nThe cipher text is obtained by reading from top to bottom, left to right.\nIn this example, the cipher text is\n\n```\npvmwnreergo o!\n```\n\n## Setup\n\n### Using Nix\n\nTo follow this path at least Nix has to be installed (and flakes have to be enabled).\n\n- `nix develop` will drop you into a shell containing everything to further hack on the project.\nInside the devShell invoking `scytale` should bring up a prompt.\n\n- `nix run` will run the default app of the flake file.\n\n- `nix build` will build the default package with the help of [poetry2nix](https://github.com/nix-community/poetry2nix)\n\n- [default.nix](./default.nix) is included to build the package the non-flake way with `nix-build`.\n- [shell.nix](./shell.nix) contains instructions to provide a non-flake shell via `nix-shell`.\n\n### Without Nix\n\nAt least Poetry needs to be installed.\n\n- `poetry run scytale` will activate the poetry environment and execute the script held in [pyproject.toml](./pyproject.toml#L3).\n If errors are occurring `poetry install` (installs the virtual environment and all given requirements)\n\n- `poetry shell` (activates and enters the virtual environment)\n\n- `poetry run python -m unittest discover` (runs all tests). Alternatively `poetry run python -m pytest tests` to use pytest for test execution.\n",
"bugtrack_url": null,
"license": "Unlicense",
"summary": "Scytale cipher algorithm cli tool",
"version": "0.1.2",
"split_keywords": [
"scytale",
"cipher",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdc374bf232dd40b3e092f3e5b326684c51d86e30cfc3ab17632be9ca1c4e149",
"md5": "3aebab01aa46ce2f2a20a6eed6fb8b35",
"sha256": "327d35e4cb43577eb6997df5c1c20c07035b61e9b9876d197908d8b5946d3938"
},
"downloads": -1,
"filename": "scytale_cipher-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3aebab01aa46ce2f2a20a6eed6fb8b35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 5424,
"upload_time": "2023-01-06T23:02:57",
"upload_time_iso_8601": "2023-01-06T23:02:57.383581Z",
"url": "https://files.pythonhosted.org/packages/cd/c3/74bf232dd40b3e092f3e5b326684c51d86e30cfc3ab17632be9ca1c4e149/scytale_cipher-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f06b4b81e37f02953007a18a017b94cb76eeeaec35164d2a8b24514267e27aaa",
"md5": "8baad1edebc0008ebf716528f2cdad53",
"sha256": "7a180fa19319a01516ad08a2b41fb71190b49fbe83b6ae363d9abcdef9f69dfa"
},
"downloads": -1,
"filename": "scytale_cipher-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "8baad1edebc0008ebf716528f2cdad53",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 4307,
"upload_time": "2023-01-06T23:02:58",
"upload_time_iso_8601": "2023-01-06T23:02:58.720596Z",
"url": "https://files.pythonhosted.org/packages/f0/6b/4b81e37f02953007a18a017b94cb76eeeaec35164d2a8b24514267e27aaa/scytale_cipher-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-06 23:02:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "lockejan",
"github_project": "scytale",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scytale-cipher"
}
JSON
