Giter VIP home page Giter VIP logo

readme-fads's Introduction

readme-fads

===========

what can we learn from the README files from the best Github repos?

Demo

http://107.170.114.168/index.html A live demo of the results of this project

Requirements

  • Python 3
  • pip for installing pyquery, pygithub
  • access to the github API (no need to auth)
  • site is in pure HTML (for the time being)

How to

  • readme-scrapper-condenser.py gets the top 150 most starred README files (as rendered HTML) of the most popular languages of Github
  • readme-scrapper-condenser.py also does the data wrangling by accessing each README file with pyquery to get the interesting parts
  • site displays the output (python script outputs json files) in a somewhat attractive way

ye be warned: github's api has quite strict limits so workaround this fact or use the readme files in this repo (folder readme_files)

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.