mingrammer/pyreportcard

Python Report Card

Analyze and report the python projects which are on Github

Inspired by Go Report Card

A report card for your Python applications. This analyzes the source code quality (pep8, pyflakes and bandit etc.) of the Python projects which are hosted on GitHub, checks for license and readme files, and provides some statistics. Then shows the results on the web.

You can see our planning for future versions in here too.

ScreenShots

Features

• Supports checking the code quality using PEP8 and Pyflakes linting tools
• Supports counting the code lines and calculates some stats
• Supports checking the license file
• Provides a grade system
• Provides a pyreportcard web server
• Supports checking the compatibility of Python 2 and 3
• Supports checking the security issues
• Supports customizable analyzing using own configuration file
• Serves it as web service
• Provides ranking system
• Provides badge link of repository grade

Install and Run

• Clone this repository.
• Run pip install -r requirements.txt to install all dependencies (If you don't have pip, install pip first)
• Install the MongoDB that is used for our backend database.
• You must configure the secret values in config_secret.py. Firstly, copy the example secret file to create secret file by cp config_secret.py.example config_secret.py, and then fill out the secret values with yours.

class SecretConfig:
    SECRET_KEY = '...'

    MONGO_DBNAME = 'reportcard'
    MONGO_HOST = '...'
    MONGO_PORT = ...
    # MONGO_USER = '...'
    # MONGO_PASSWORD = '...'

• Run server by python3 run.py.
• Go 127.0.0.1:5000 and just use it.

It is also possible to run the app and MongoDB in isolated environment using Docker and docker-compose. Follow the instructions above up until setting the secret values. Then, create a .env file comprises of environment variables for configuring the app in the container. An example of .env is provided below:

echo "DEBUG=1" >> .env
echo "FLASK_DEBUG=1" >> .env
echo "FLASK_ENVIRONMENT=development" >> .env

To run the app and MongoDB, build the app and run them using docker-compose. By default, the app will bind to port 5000 and can be accessed via localhost, e.g. 127.0.0.1:5000. If the port conflicted with other running apps, feel free to modify the port binding in docker-compose.yml and re-run the app.

docker-compose up --build -d

Reminder: If you are going to run the app in production, do not forget to turn off DEBUG flags in .env file and set the environment to production.

Tests

Note: We have a test code for only vcs module now. We'll add more tests for all features soon

python3 -m unittest discover tests

Dependencies

• PEP8
• Pyflakes
• PyMongo
• Flask
• MongoDB

License

The content of this project itself is licensed under the Creative Commons Attribution 3.0 license, and the underlying source code used to format and display that content is licensed under the MIT license.