Giter Club home page Giter Club logo

auto-cleaning-python-repo's Introduction

Auto Cleaning and Formatting python repo

Automatic Code Cleaning & Formatter

This repo contains multiple CI/CD GitHub Action-based workflow tests to keep python repositories clean and high quality

After any push:

  • A 'code-cleaner' GitHub action runs automatically
  • It performs various cleaning and formatting steps
  • Automatically push the files affected by those steps

List of performed steps (in-order of execution):

1. Cleaning Notebook (.ipynb) Outputs ๐Ÿงผ

This way, the notebooks are always clean and the output cells are not included!

2. Auto Formatting in PEP8 ๐Ÿ—๏ธ

Any python file is modified and made PEP8-compliant!

  • It uses the autoyapf open-source library
  • โŒ TODO: Doesn't work on ipynb python cells!?!
  • โŒ TODO: Let it run on all notebooks in the repo

How to test:

  • Modify or create a python script (not compliant with PEP8) and run the notebook to produce some outputs
  • Push
  • Wait for GitHub action to run
  • Look at your beautiful quality code ๐Ÿƒ

auto-cleaning-python-repo's People

Contributors

mansitos avatar danielepassabi avatar

Watchers

 avatar

Forkers

danielepassabi

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.