Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/electux/codecipher
CODECipher is fwk for cipher utilities.
https://github.com/electux/codecipher
bsd cipher cipher-algorithms freebsd linux macos macosx python3 qnx unix windows
Last synced: 22 days ago
JSON representation
CODECipher is fwk for cipher utilities.
- Host: GitHub
- URL: https://github.com/electux/codecipher
- Owner: electux
- License: gpl-3.0
- Created: 2021-10-30T01:45:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T16:37:56.000Z (5 months ago)
- Last Synced: 2024-10-04T21:51:37.197Z (about 1 month ago)
- Topics: bsd, cipher, cipher-algorithms, freebsd, linux, macos, macosx, python3, qnx, unix, windows
- Language: Python
- Homepage: https://electux.github.io/codecipher
- Size: 4.21 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CODECipher
**codecipher** is package for cipher utilities.
Developed in **[python](https://www.python.org/)** code.
The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/electux/codecipher/actions/workflows/codecipher_python_checker.yml) [](https://github.com/electux/codecipher/actions/workflows/codecipher_package.yml) [](https://github.com/electux/codecipher/issues) [](https://github.com/electux/codecipher/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Usage](#usage)
- [Package structure](#package-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and Licence](#copyright-and-licence)
### Installation
Used next development environment
Used next development environment
[](https://github.com/electux/codecipher/actions/workflows/codecipher_python3_build.yml)
Currently there are three ways to install package
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism
##### Install using pip
**codecipher** is located at **[pypi.org](https://pypi.org/project/codecipher/)**.
You can install by using pip
```bash
# python3
pip3 install codecipher
```
##### Install using build
Navigate to **[release page](https://github.com/electux/codecipher/releases)** download and extract release archive.
To install **codecipher**, run
```bash
tar xvzf codecipher-x.y.z.tar.gz
cd codecipher-x.y.z
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install codecipher-x.y.z-py3-none-any.whl
rm -f get-pip.py
```
##### Install using py setup
Navigate to **[release page](https://github.com/electux/codecipher/releases)** download and extract release archive.
To install **codecipher**, locate and run setup.py with arguments
```bash
tar xvzf codecipher-x.y.z.tar.gz
cd codecipher-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**codecipher** requires other modules and libraries (Python 3.x)
* None
### Usage
```python
from codecipher.a1z52n62 import A1z52N62
from codecipher.atbs import AlephTawBetShin
from codecipher.b64 import B64
from codecipher.caesar import Caesar
from codecipher.vigenere import Vigenere
from codecipher.vernam import Vernam
print("A1z52N62 cipher")
cipher = A1z52N62()
data = "More Human Than Human01 Is Our Motto"
# encoding data
cipher.encode(data)
# encoded data
print(cipher.encode_data)
# decoding data
cipher.decode(cipher.encode_data)
# decoded data
print(cipher.decode_data)
print(50*'=')
print("AlephTawBetShin cipher")
cipher = AlephTawBetShin()
data = "More Human Than Human01 Is Our Motto"
# encoding data
cipher.encode(data)
# encoded data
print(cipher.encode_data)
# decoding data
cipher.decode(cipher.encode_data)
# decoded data
print(cipher.decode_data)
print(50*'=')
print("B64 cipher")
cipher = B64()
data = "More Human Than Human01 Is Our Motto"
# encoding data
cipher.encode(data)
# encoded data
print(cipher.encode_data)
# decoding data
cipher.decode(cipher.encode_data)
# decoded data
print(cipher.decode_data)
print(50*'=')
print("Caesar cipher")
cipher = Caesar()
data = "More Human Than Human01 Is Our Motto"
# encoding data
cipher.encode(data, 3)
# encoded data
print(cipher.encode_data)
# decoding data
cipher.decode(cipher.encode_data, 3)
# decoded data
print(cipher.decode_data)
print(50*'=')
print("Vigenere cipher")
cipher = Vigenere()
data = "More Human Than Human01 Is Our Motto"
cipher.data_len = len(data)
cipher.key = "AYUSH"
cipher.generate_key()
# encoding data
cipher.encode(data, cipher.key)
# encoded data
print(cipher.encode_data)
# decoding data
cipher.decode(cipher.encode_data, cipher.key)
# decoded data
print(cipher.decode_data)
print(50*'=')
print("Vernam cipher")
cipher = Vernam()
data = "More Human Than Human01 Is Our Motto"
# encoding data
cipher.encode(data, "randomrandomrandom")
# encoded data
print(cipher.encode_data)
# decoding data
cipher.decode(cipher.encode_data, "randomrandomrandom")
# decoded data
print(cipher.decode_data)
print(50*'=')
```
### Package structure
**codecipher** is based on OOP.
Package structure
```bash
codecipher/
├── a1z52n62/
│ ├── decode.py
│ ├── encode.py
│ └── __init__.py
├── atbs/
│ ├── decode.py
│ ├── encode.py
│ ├── __init__.py
│ └── lookup_table.py
├── b64/
│ ├── decode.py
│ ├── encode.py
│ └── __init__.py
├── caesar/
│ ├── decode.py
│ ├── encode.py
│ └── __init__.py
├── __init__.py
├── py.typed
├── vernam/
│ ├── decode.py
│ ├── encode.py
│ └── __init__.py
└── vigenere/
├── decode.py
├── encode.py
├── __init__.py
├── key_generator.py
└── lookup_table.py
7 directories, 23 files
```
### Docs
[](https://codecipher.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [codecipher.readthedocs.io](https://codecipher.readthedocs.io/en/latest/)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to codecipher](CONTRIBUTING.md)
### Copyright and Licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2021 - 2024 by [electux.github.io/codecipher](https://electux.github.io/codecipher/)
**codecipher** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 3.x or,
at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)