Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code standards: Python #7

Open
simcof opened this issue May 19, 2020 · 3 comments
Open

Code standards: Python #7

simcof opened this issue May 19, 2020 · 3 comments

Comments

@simcof
Copy link
Contributor

simcof commented May 19, 2020

No description provided.

@chinmayshah99
Copy link
Member

We should use a strict black standards?

@karlhigley
Copy link
Contributor

PySyft's automated code standards can be found in the Github action for testing and the flake8 config. We enforce:

  • No syntax errors or undefined names
  • Naming that conforms with PEP8
  • Code formatting with Black
  • A variety of flake8 style rules
  • 95% code coverage from tests (and 100% coverage of the tests themselves)
  • Minimum ~50% docstring coverage
  • No medium or high severity security issues from Bandit (low severity issues are things like "use of assert", which would be more a pain to get rid of than live with)

@TTitcombe
Copy link
Member

Thoughts on isort?
PySyft has a defined import style in the contributing doc, but it's not enforced AFAIK

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants