blockit - cli tool for encrypting and decrypting strings
Project description
BlockIt
BlockIt is a Python package that provides various encryption algorithms and a CLI application for easy encryption and decryption of text. It implements the ShiftEncryption, ReverseEncryption, and MatrixEncryption algorithms and allows dynamic selection of encryption algorithms using Abstract Factory design pattern.
Deliverables
- Implemented the following encryption algorithms: ShiftEncryption, ReverseEncryption, MatrixEncryption
- Add the
--shift
option to specify the number of shifts to be performed instead of being fixed at 3 - Dockerized the project, enabling easy testing of the application in a containerized environment using docker-compose
- Utilized the Abstract Factory Design Pattern, enabling dynamic creation of encryption algorithms
- Developed a CLI application using
Typer
, facilitating easy text encryption and decryption - Distributed and published the package on PyPI at https://pypi.org/project/blockit/
- Reimplemented the Reverse Encryption Algorithm and deployed it on Vercel as a FastAPI application. This was necessary due to the previously provided endpoints experiencing timeouts and functionality issues.
- Published a Postman collection for the API endpoints, available at https://documenter.getpostman.com/view/8975155/2s93zB528T
- Utilized semantic commit messages to effectively track the project's progress
- Wrote comprehensive unit tests for all encryption algorithms: ShiftEncryption, ReverseEncryption, MatrixEncryption
- Utilized
pytest
andpytest-cov
to run tests and generate coverage reports - Incorporated
pre-commit
hooks to ensure consistent formatting, type checking, and linting before each commit - Automated formatting and versioning of the package using a
Makefile
- Documentation including installation instructions, usage guidelines, known issues, testing instructions, and research details.
- A well-documented codebase, providing clear documentation for each function and class
Installation
Inside a Docker Container
- Run
docker-compose up --build
to build the image and run the container - Run
docker-compose exec web bash
to enter the container - The
blockit
CLI is now available inside the container
Published CLI
- Install the package using
pip install blockit
- Run
blockit --help
to see the available commands and options
Usage: blockit [OPTIONS] TEXT ALGORITHM METHOD
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * text TEXT Text to be encrypted/decrypted [default: None] [required] │
│ * algorithm TEXT Encryption algorithm to be used [default: None] [required] │
│ * method TEXT Method to be used: 'Encrypt' or 'Decrypt' [default: None] [required] │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Manually
- Clone the repository,
git clone https://github.com/0xsirsaif/blockit
, andcd
into it - Create a virtual environment,
python -m venv venv
, and activate it,source venv/bin/activate
- Install the dependencies,
pip install -r requirements.txt
- Run
python -m blockit --help
to see the available commands and options
Usage
ShiftEncryption
- default shift value is 3, but can be changed using the
--shift
option
$ blockit "Hello World" shift Encrypt
Khoor Zruog
$ blockit "Khoor Zruog" shift Decrypt
Hello World
ReverseEncryption
$ blockit "Hello World" reverse Encrypt
dlroW olleH
$ blockit "dlroW olleH" reverse Decrypt
Hello World
MatrixEncryption
$ blockit "Hello World" matrix Encrypt
$ blockit "Hello World" matrix Decrypt
Testing
Tests are grouped into three Test Classes: TestShiftEncryption, TestReverseEncryption, and TestMatrixEncryption.
- To run all tests, run the following command:
$ python -m pytest --cov tests/ -vvs
- To run a specific test with keyword, run the following command:
$ python -m pytest --cov tests/ -vvs -k <keyword>
Known Issues
Please be aware that there is currently a bug in the MatrixEncryption
algorithm. I have been unable to fix it in time for the deadline, but I will continue working on it and will push the fix as soon as possible. I've added a test case for the bug as well.
License
MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.