Skip to content

Continuous Development

Divyank Shah edited this page Sep 27, 2022 · 1 revision

PyLint

Pylint is a code linter that will be statically analyzing your code for common errors, such as using variables which do not exist and importing packages you do not need. Checkout the documentation if you are interested in learning more about PyLint, I suggest referring to the Official PyLint Documentation

To run PyLint, you can use the following command to run PyLint:

poetry run pylint .

YAPF

YAPF stands for Yet Another Python Formatter is a formatter by Google that will format your code to certain standards. It ensures fundamentals such as correct whitespace usage and utilizing common practices to ensure that the code is formatted the same for every developer. You can learn more about YAPF from the YAPF Official Documentation

To run YAPF, you can use the following command to run YAPF:

This command will simply print out the differences between your code and the properly formatted code!

poetry run yapf . -dr

This command will reformat your code. It will not change the logic of the code!

poetry run yapf . -ir

Continuous Development / Integration

Continuous Development / Continuous Integration assists with our ability to collaborate efficiently and ensure that our code is working properly. It highlights immediate red flags that may have broken production and allows developers to tackle it before code is taken to production. In this repository, we will be checking for listing and formatting before allowing developers to merge their code. When such actions are running and fail, you can check which tasks failed and click on details to get a deeper dive into what commands were run, with which you can run locally or observe the logs to understand where the error lies.

Clone this wiki locally