Giter VIP home page Giter VIP logo

amooo-ooo / pep8plus Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 1.0 473 KB

Online syntax checker built for educational institutions to help students enforce Python programming standards.

Home Page: http://pep8plus.com

License: MIT License

HTML 1.05% JavaScript 0.42% Svelte 65.22% Python 8.03% SCSS 19.57% TypeScript 0.58% CSS 5.14%
flake8 online pep8 pep8-checker python ruff svelte flask full-stack

pep8plus's Introduction

pep8plus logo

pep8plus

Online Python syntax checker for educational institutions.

pep8plus

pep8plus is an open-source online tool built for educational institutions to help students enforce and maintain Python programming standards. Powered by Ruff, Flake8 and Pylint, pep8plus is built on the principle of customisability, ease of use and user experience.

Warning This project is still in its early stages. Hence, bugs and ironically, questionable programming practices may be present.

Features

Here are a few major features of pep8plus:

  • Customisation: pep8plus offers three different popular linters: Ruff, Pylint and Flake8. With over 800 built-in convention guides and rules combined, all convention settings are able to be easily activated and deactivated to share with students.
  • Shareability: Easily share customised convention settings with students by generating a custom link.
  • Open-source: pep8plus gives the opportunity for institutions to host the project and implement their own conventions and plugins.

and more!

Categories

Convention rules are given tags which are colour-coded based on their severity.

Colour Severity Description
#EB514C error There is an error or some sort of issue with the code.
#FF7B72 syntax-error Convention error is found within the code.
#FFB618 severe-warning High priority warning with code's syntax.
#FFA657 warning Warning with code's syntax
#D2A8ff complex Complex convention issues. (For more experienced developers)
#524669 super-complex More complex convention issues. (For more experienced developers)
#79C0FF neutral Neutral convention issues with syntax.

Quick Start

git clone https://github.com/amooo-ooo/pep8plus

Setup

Setup dependencies by running the following on the terminal:

pip install -r requirements.txt
cd client
npm install

Hosting

Simply run python server.py to host the project:

python server.py

Support

pep8plus was created as a school project with the aspiration of helping other young Pythonistas enforce and learn python coding practices. The purpose of this project is to provide educators with a transparent, customisable and easy solution to helping their students enforce Python conventions.

Contact

You can contact me at [email protected].

pep8plus's People

Contributors

amooo-ooo avatar syntheticsam avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

syntheticsam

pep8plus's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.