Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 2.88 KB

README.md

File metadata and controls

97 lines (65 loc) · 2.88 KB

DataPilot

The DataPilot is a web application developed using the Django web framework. It provides users with a simple web-based interface to execute SQL queries and view the results. The application includes user authentication, and user-specific database assignment to ensure a secure and personalized experience. However, each user can have only one database for the time being.

Table of Contents

Features

  • User authentication: Register, login, and logout functionality.
  • User-specific database assignment: Each user is assigned a unique database file for executing SQL queries.
  • SQL Query Execution: Execute SQL queries and view the results in a tabular format.
  • Error handling: Informative error messages for invalid queries or potential issues.
  • Database Table Information (DESC): Users can retrieve table information, including column names and properties.

Technologies Used

  • Python: The programming language used for backend development.
  • Django: The web framework responsible for request handling and application management.
  • SQLite: The database management system used to store user data.
  • django-allauth: A package for user authentication.
  • HTML/CSS: Markup and styling languages for the user interface.

Getting Started

Installation

  1. Make sure you have Python installed on your system. If not, download and install it from the official website: https://www.python.org/downloads/

  2. Clone this repository to your local machine:

git clone https://github.com/arindam-sahoo/datapilot.git
cd datapilot
  1. Create a virtual environment (optional but recommended):
python -m venv .venv
  1. Activate the virtual environment (Windows):
.\.venv\Scripts\activate
  1. Activate the virtual environment (macOS/Linux):
source .venv/bin/activate
  1. Install the required packages:
pip install -r requirements.txt

Running the Application

  1. Create the SQLite database and apply migrations:
python manage.py migrate
  1. Start the development server:
python manage.py runserver
  1. Access the application in your web browser at http://127.0.0.1:8000/.

Usage

  1. Register a new account using your email address and password.
  2. Upon successful authentication, you will be redirected to the DataPilot dashboard.
  3. Enter your SQL queries in the provided textarea and click "Execute" to see the results.

Contributing

Contributions are welcome! If you find any issues or want to add new features, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.