Skip to main content

Installation

Get Algoritmos de Encriptamiento running on your local machine in just a few steps.

Prerequisites

Before you begin, ensure you have the following installed:
  • Python 3.6 or higher (Python 3.13 recommended)
  • Git for cloning the repository
  • pip (usually comes with Python)
You can check your Python version by running python --version in your terminal.

Installation steps

1

Clone the repository

Clone the project repository to your local machine:
git clone https://github.com/RennfahrerU/Algoritmos-de-Encriptamiento.git
cd Algoritmos-de-Encriptamiento
2

Install pipenv

Install pipenv to manage the project dependencies:
pip install pipenv
Pipenv creates isolated virtual environments and manages package versions automatically.
3

Install dependencies

Use pipenv to install the required packages:
pipenv install
This command reads the Pipfile and installs Flask and other dependencies in a virtual environment.
[packages]
flask = "*"

[requires]
python_version = "3.13"
4

Verify installation

Verify that everything is installed correctly by checking the pipenv environment:
pipenv --venv
This should print the path to your virtual environment.

Project structure

Once installed, you’ll find the following structure:
Algoritmos-de-Encriptamiento/
├── app.py              # Flask web application
├── main.py             # CLI version
├── sustitucion.py      # Caesar cipher implementation
├── transposicion.py    # Transposition cipher implementation
├── RSA.py              # RSA encryption implementation
├── util.py             # Utility functions
├── static/             # CSS and web resources
├── templates/          # HTML templates for web interface
├── Pipfile             # Dependencies
└── Pipfile.lock        # Locked dependency versions

Running the application

You can run the application in two ways:

Web interface

pipenv run python app.py
Once running, open your browser and navigate to http://localhost:5000.

Command-line interface

pipenv run python main.py
The CLI will prompt you for a message and automatically apply all three encryption algorithms.
The web interface runs on Flask’s development server. It’s perfect for learning but not suitable for production deployment.

Troubleshooting

Python version mismatch

If you encounter a Python version error, you can modify the Pipfile to match your installed Python version:
Pipfile
[requires]
python_version = "3.11"  # Change to your version
Then run pipenv install again.

Port already in use

If port 5000 is already in use, you can modify app.py to use a different port:
app.py
if __name__ == '__main__':
    app.run(debug=True, port=5001)  # Change port here

Next steps

Now that you have everything installed, head over to the quick start guide to encrypt your first message!

Build docs developers (and LLMs) love