Summary:
Welcome to 'Oops I Did It Again,' a project dedicated to helping Python developers overcome non-Pythonic coding habits and write code that adheres to PEP 8 best practices. If you ever find yourself slipping into C++-like syntax when writing Python code, you're not alone. The project's goal is simple: to guide you in writing Python code that is clean, readable, and truly Pythonic. Whether you're a Python beginner or a seasoned developer, you'll find valuable insights here.
These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.
To run this project, you will need to have the following software installed on your machine:
- Python3: You can download and install Python3 from the official website:
- Java Development Kit (JDK): If you plan to work with Java code, you will need to have the Java Development Kit installed. You can download and install the JDK from the official Oracle website or use OpenJDK:
- C++ Compiler: For working with C++ code, you will need a C++ compiler. If you're on a Linux-based system, you may already have g++ installed. On Windows, you can use MinGW or Microsoft Visual C++.
- pip (Python's package manager): If you don't already have pip installed with Python3, you can refer to the official pip installation guide for installation instructions.
You will also need to have Flask and flask_sqlalchemy packages installed to run this application. These will be installed as part of the project's requirements, as mentioned in the "Installing" section in the README.
- Clone the repository to your local machine
git clone https://github.com/anxkhn/Oops-I-did-it-again.git
- Navigate to the project directory
cd Oops-I-did-it-again
- Install the necessary packages
pip install -r requirements.txt
- Start the application
flask run
The application will now be running on http://127.0.0.1:5000
This app is intended to be deployed on a web server. You can use PythonAnywhere to deploy this application.
- Flask - A microframework for Python web applications
- CS50 - Harvard CS50's library for Python
- CodeMirror - A versatile text editor implemented in JavaScript for browser-based code editing.
- Material Bootstrap - A Material Design theme for Bootstrap, providing a modern and clean user interface.
- Werkzeug - A Flask framework that implements WSGI for handling requests.
- Jinja2 - A templating language for Python, used by Flask.
Additionally, you will need the compilers library for Python, C++, and Java installed on your machine, as well as some other libraries (prebuilt) like subprocess, time, and os.
To contribute to the project, please follow the CONTRIBUTING guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.