moz-np / pyjector Goto Github PK

Great work, team pyJector. Here are few changes you can make to improve the project.

• Move the instructions from Insturctions.txt to README.md. That way, it's available directly from the repo.

• In python, snake_case naming convention is preferred rather than camelCase. So, grab_screen.py instead of grabScreen.py and similarly for other variables.

• In client.py,

  • this library is imported but not used 'import cv2'
  • Line 13: a = True defined but not used
  • Line 16: pygame.quit() won't work since you've imported pygame as import pygame as py

• Formatting:

  • Find a PEP8 plugin for text editor you use (e.g. SublimeLinter-pep8 for SublimeText) and apply PEP8 formatting. That way the code will be cleanly formatted.
  • Indentation used is not multiple of 4. It's preferred in python to use 4 spaces for indentation(this can also be fixed by the previous plugin.)

• Licensing

  • Add a license(e.g. MIT or GPL) you find suitable for the project. If a license is not specified for a project, then by default it's assumed that the project copyright goes to the owners i.e. the source code is not meant to be freely used and distributed. Choose any one license and add a LICENSE.md file to the repo. Use this site to decide which license is suitable.

Currently, README.md looks all over the places. It needs some love.