BreachCheck - Sagittarius

## Introduction

We strongly advise users to only utilize BreachCheck for their own emails and passwords. Do not misuse this tool or exploit it for malicious purposes. Respect the privacy and security of others by refraining from attempting to check passwords that do not belong to you.

Our aim is to promote responsible and ethical use of BreachCheck to empower individuals in securing their online presence. By adhering to these principles, we can collectively contribute to a safer digital environment for everyone.

You can experience the application https://breachcheck-sagittarius.streamlit.app/ which is hosted on Streamlit Sharing Cloud.

Project Structure

BreachCheck/
│
├── Interfaces/
│   └── streamlit_app.py  # Main Streamlit application interface
│
├── api/
│   └── breach_api.py  # API integration for breach checks
│
├── scripts/
│   ├── run_app  # Extensionless script to detect OS and run the appropriate script
│   ├── run_app.sh  # Shell script for Unix-based systems
│   ├── run_app.bat  # Batch script for Windows
│   └── run_app.ps1  # PowerShell script for Windows
│
├── docs/
│   ├── faq_and_contributions.py  # Frequently Asked Questions and Contributions
│   └── terms.md  # Terms and Conditions
│
├── README.md  # Project documentation
├── conf.json  # Configuration file for API keys and settings
├── requirements.txt  # Python dependencies
├── app.py  # Entry point to run the Streamlit application
└── app_complete.py  # Entry point to run the Complete Streamlit application in a single file.

Note: This app_complete.py file is not used in the project and is a little behind the main app.py file. For Contributions, please refer to the app.py file.

Usage

Prerequisites

Ensure you have Python 3.6 or later installed on your system.

Installation

1. Clone the repository:

   git clone https://github.com/VKrishna04/BreachCheck.git
   cd BreachCheck

2. Create a virtual environment (not required): On Linux

   python -m venv venv
   source venv/bin/activate

   On Windows

   python -m venv venv
   source venv\Scripts\activate

   On MacOS

   python3 -m venv venv
   source venv/bin/activate

This will provide clear instructions for setting up and activating a virtual environment on both Windows and macOS.

3. Install the required packages:

   pip install -r requirements.txt

This is for installing the necessary packages to run the Streamlit application and tabulate package required in cli interface.

Running the Application

To run the Streamlit application there are three ways:

1. You can visit this site https://breachcheck-sagittarius.streamlit.app/ to use the Streamlit app which is hosted on Streamlit Sharing Cloud.

2. Using the batch file, use the following command:

   .\run_app.bat

3. Using the shortcut file named "Sagittarius" in the root directory of the project. It is the name of the team which made this project.

Note: If you are using the batch file, make sure to run it from the root directory of the project.

3. Don't run the Streamlit app python file manually, it will not work as expected since it is set to open CLI.

4. To modify the user theme of the Streamlit app, you can change the necessary variables here. The theme is set to "dark" by default.

Running the CLI Interface

To run the CLI interface manually, use the following command:

python app.py --cli

Complete App in single file

Below is the complete code for the application which is running directly without any support files:

To run this code as a normal Python file to use CLI, use the following command:

python app_complete.py --cli

To run this code as a Streamlit app, use the following command:

streamlit run app_complete.py

Contributors

Team Leader

1. @VKrishna04

Frontend

1. @harsha4678 <- Figma Landing Page
2. @longhxirguy <- Streamlit Frontend

APIs Integration

1. @Karthikkkk123 <- Streamlit Interface
2. @Saisriram-88 <- CLI

Support / Error Testing

1. @Jayanth-0703