CODECipher

codecipher is package for cipher utilities.

Developed in python 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.

Table of Contents

• Installation
  • Install using pip
  • Install using build
  • Install using py setup
  • Install using docker
• Dependencies
• Usage
• Package structure
• Code coverage
• Docs
• Contributing
• Copyright and Licence

Installation

Used next development environment

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.

You can install by using pip

# python3
pip3 install codecipher

Install using build

Navigate to release page download and extract release archive.

To install codecipher, run

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 download and extract release archive.

To install codecipher, locate and run setup.py with arguments

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

fromcodecipher.a1z52n62.engineimportA1Z52N62fromcodecipher.atbs.engineimportATBSfromcodecipher.b64.engineimportB64fromcodecipher.caesar.engineimportCaesarfromcodecipher.vigenere.engineimportVigenerefromcodecipher.vernam.engineimportVernamprint("A1z52N62 cipher")
cipher=A1Z52N62()
data="More Human Than Human01 Is Our Motto"# encoding dataencode_data=cipher.encode(data)
# encoded dataprint(encode_data)
# decoding datadecode_data=cipher.decode(encode_data)
# decoded dataprint(decode_data)
print(50*'=')
print("ATBS cipher")
cipher=ATBS()
data="More Human Than Human01 Is Our Motto"# encoding dataencode_data=cipher.encode(data)
# encoded dataprint(encode_data)
# decoding datadecode_data=cipher.decode(encode_data)
# decoded dataprint(decode_data)
print(50*'=')
print("B64 cipher")
cipher=B64()
data="More Human Than Human01 Is Our Motto"# encoding dataencode_data=cipher.encode(data)
# encoded dataprint(encode_data)
# decoding datadecode_data=cipher.decode(encode_data)
# decoded dataprint(decode_data)
print(50*'=')
print("Caesar cipher")
cipher=Caesar()
data="More Human Than Human01 Is Our Motto"# encoding dataencode_data=cipher.encode(data)
# encoded dataprint(encode_data)
# decoding datadecode_data=cipher.decode(encode_data)
# decoded dataprint(decode_data)
print(50*'=')
print("Vigenere cipher")
cipher=Vigenere()
data="More Human Than Human01 Is Our Motto"# encoding dataencode_data=cipher.encode(data)
# encoded dataprint(encode_data)
# decoding datadecode_data=cipher.decode(encode_data)
# decoded dataprint(decode_data)
print(50*'=')
print("Vernam cipher")
cipher=Vernam()
data="More Human Than Human01 Is Our Motto"# encoding dataencode_data=cipher.encode(data)
# encoded dataprint(encode_data)
# decoding datadecode_data=cipher.decode(encode_data)
# decoded dataprint(decode_data)
print(50*'=')

Package structure

codecipher is based on OOP.

Package structure

 codecipher/
├── a1z52n62/
│ ├── config.py
│ ├── decode/
│ │ ├── decode_algorithm.py
│ │ ├── decoder.py
│ │ └── __init__.py
│ ├── encode/
│ │ ├── encode_algorithm.py
│ │ ├── encoder.py
│ │ └── __init__.py
│ ├── engine.py
│ └── __init__.py
├── abstracts/
│ ├── ialgorithm.py
│ ├── icharacter_validator.py
│ ├── icipher_engine.py
│ ├── iconfig.py
│ ├── idata_validator.py
│ ├── idecoder.py
│ ├── iencoder.py
│ ├── __init__.py
│ └── ivalidation_engine.py
├── atbs/
│ ├── config.py
│ ├── decode/
│ │ ├── decode_algorithm.py
│ │ ├── decoder.py
│ │ └── __init__.py
│ ├── encode/
│ │ ├── encode_algorithm.py
│ │ ├── encoder.py
│ │ └── __init__.py
│ ├── engine.py
│ └── __init__.py
├── b64/
│ ├── config.py
│ ├── decode/
│ │ ├── decode_algorithm.py
│ │ ├── decoder.py
│ │ └── __init__.py
│ ├── encode/
│ │ ├── encode_algorithm.py
│ │ ├── encoder.py
│ │ └── __init__.py
│ ├── engine.py
│ └── __init__.py
├── caesar/
│ ├── config.py
│ ├── decode/
│ │ ├── decode_algorithm.py
│ │ ├── decoder.py
│ │ └── __init__.py
│ ├── encode/
│ │ ├── encode_algorithm.py
│ │ ├── encoder.py
│ │ └── __init__.py
│ ├── engine.py
│ └── __init__.py
├── __init__.py
├── py.typed
├── validation/
│ ├── character_validator.py
│ ├── data_validator.py
│ ├── __init__.py
│ └── validation_engine.py
├── vernam/
│ ├── config.py
│ ├── decode/
│ │ ├── decode_algorithm.py
│ │ ├── decoder.py
│ │ └── __init__.py
│ ├── encode/
│ │ ├── encode_algorithm.py
│ │ ├── encoder.py
│ │ └── __init__.py
│ ├── engine.py
│ └── __init__.py
└── vigenere/
├── config.py
├── decode/
│ ├── decode_algorithm.py
│ ├── decoder.py
│ └── __init__.py
├── encode/
│ ├── encode_algorithm.py
│ ├── encoder.py
│ └── __init__.py
├── engine.py
└── __init__.py
21 directories, 69 files

Code coverage

Name	Stmts	Miss	Cover
codecipher/__init__.py	9	0	100%
codecipher/a1z52n62/__init__.py	9	0	100%
codecipher/a1z52n62/config.py	26	0	100%
codecipher/a1z52n62/decode/__init__.py	9	0	100%
codecipher/a1z52n62/decode/decode_algorithm.py	41	6	85%
codecipher/a1z52n62/decode/decoder.py	30	2	93%
codecipher/a1z52n62/encode/__init__.py	9	0	100%
codecipher/a1z52n62/encode/encode_algorithm.py	32	2	94%
codecipher/a1z52n62/encode/encoder.py	30	2	93%
codecipher/a1z52n62/engine.py	36	0	100%
codecipher/abstracts/__init__.py	9	0	100%
codecipher/abstracts/ialgorithm.py	16	1	94%
codecipher/abstracts/icharacter_validator.py	14	1	93%
codecipher/abstracts/icipher_engine.py	17	2	88%
codecipher/abstracts/iconfig.py	23	0	100%
codecipher/abstracts/idata_validator.py	14	1	93%
codecipher/abstracts/idecoder.py	10	2	80%
codecipher/abstracts/iencoder.py	10	2	80%
codecipher/abstracts/ivalidation_engine.py	18	2	89%
codecipher/atbs/__init__.py	9	0	100%
codecipher/atbs/config.py	26	0	100%
codecipher/atbs/decode/__init__.py	9	0	100%
codecipher/atbs/decode/decode_algorithm.py	28	3	89%
codecipher/atbs/decode/decoder.py	30	2	93%
codecipher/atbs/encode/__init__.py	9	0	100%
codecipher/atbs/encode/encode_algorithm.py	28	3	89%
codecipher/atbs/encode/encoder.py	30	2	93%
codecipher/atbs/engine.py	36	1	97%
codecipher/b64/__init__.py	9	0	100%
codecipher/b64/config.py	26	0	100%
codecipher/b64/decode/__init__.py	9	0	100%
codecipher/b64/decode/decode_algorithm.py	32	7	78%
codecipher/b64/decode/decoder.py	30	2	93%
codecipher/b64/encode/__init__.py	9	0	100%
codecipher/b64/encode/encode_algorithm.py	27	3	89%
codecipher/b64/encode/encoder.py	30	2	93%
codecipher/b64/engine.py	36	2	94%
codecipher/caesar/__init__.py	9	0	100%
codecipher/caesar/config.py	26	0	100%
codecipher/caesar/decode/__init__.py	9	0	100%
codecipher/caesar/decode/decode_algorithm.py	41	2	95%
codecipher/caesar/decode/decoder.py	30	2	93%
codecipher/caesar/encode/__init__.py	9	0	100%
codecipher/caesar/encode/encode_algorithm.py	41	2	95%
codecipher/caesar/encode/encoder.py	30	2	93%
codecipher/caesar/engine.py	36	2	94%
codecipher/validation/__init__.py	9	0	100%
codecipher/validation/character_validator.py	17	1	94%
codecipher/validation/data_validator.py	19	1	95%
codecipher/validation/validation_engine.py	24	4	83%
codecipher/vernam/__init__.py	9	0	100%
codecipher/vernam/config.py	26	0	100%
codecipher/vernam/decode/__init__.py	9	0	100%
codecipher/vernam/decode/decode_algorithm.py	44	5	89%
codecipher/vernam/decode/decoder.py	30	2	93%
codecipher/vernam/encode/__init__.py	9	0	100%
codecipher/vernam/encode/encode_algorithm.py	44	5	89%
codecipher/vernam/encode/encoder.py	30	2	93%
codecipher/vernam/engine.py	36	0	100%
codecipher/vigenere/__init__.py	9	0	100%
codecipher/vigenere/config.py	26	0	100%
codecipher/vigenere/decode/__init__.py	9	0	100%
codecipher/vigenere/decode/decode_algorithm.py	40	3	92%
codecipher/vigenere/decode/decoder.py	30	2	93%
codecipher/vigenere/encode/__init__.py	9	0	100%
codecipher/vigenere/encode/encode_algorithm.py	40	3	92%
codecipher/vigenere/encode/encoder.py	30	2	93%
codecipher/vigenere/engine.py	36	0	100%
Total	1541	90	94%

Docs

More documentation and info at

• codecipher.readthedocs.io
• www.python.org

Contributing

Contributing to codecipher

Copyright and Licence

Copyright (C) 2021 - 2026 by 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.