Skip to content

Latest commit

 

History

History
94 lines (74 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

94 lines (74 loc) · 3.78 KB
Raw

Python formatting

This project uses three methods of code style enforcement, linting, and checking:

All code that is contributed to AutoPkg must match these style requirements. These requirements are enforced by pre-commit.

Use relocatable-python to safely build 3

We recommend using Greg Neagle's Relocatable Python to build a custom Python 3 framework with the included requirements.txt.

First, create a safe path to place your frameworks. The easiest choice is /Users/Shared, because you won't have any permissions issues there, but you can place this anywhere that makes sense to you:

mkdir -p /Users/Shared/Python3

Now create your relocatable Python frameworks using the provided requirements.txt files:

./make_relocatable_python_framework.py --python-version 3.7.5 --pip-requirements /path/to/requirements.txt --destination /Users/Shared/Python3/

Symlink the frameworks

You can symlink in the python executables into a more useful path:

sudo ln -s /Users/Shared/Python3/Python.framework/Versions/3.7/bin/python3 /usr/local/bin/python3_custom

Use pre-commit to set automatic commit requirements

This project makes use of pre-commit to do automatic lint and style checking on every commit containing Python files.

To install the pre-commit hook, run the executable from your Python 3 framework while in your current autopkg git checkout:

$ cd ~/autopkg
$ /Users/Shared/Python3/Python.framework/Versions/3.7/bin/pre-commit install --install-hooks
pre-commit installed at .git\hooks\pre-commit
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-isort.
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Installing environment for https://github.com/python/black.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/mirrors-isort.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...

Once installed, all commits will run the test hooks. If your commit fails any of the tests, the commit will be rejected.

Example of a failed commit

$ git commit -m "test a bad commit for pre-commit"
black....................................................................Failed
hookid: black

Files were modified by this hook. Additional output:

reformatted Code\autopkglib\AppDmgVersioner.py
All done! \u2728 \U0001f370 \u2728
1 file reformatted.

isort....................................................................Failed
hookid: isort

Files were modified by this hook. Additional output:

Fixing C:\Users\nmcspadden\Documents\GitHub\nmcspadden-autopkg\Code\autopkglib\AppDmgVersioner.py

Flake8...................................................................Failed
hookid: flake8

Code/autopkglib/AppDmgVersioner.py:31:1: E303 too many blank lines (3)

Example of a successful commit

$ git commit -m "test a good commit for pre-commit"
black....................................................................Passed
isort....................................................................Passed
Flake8...................................................................Passed
[test ebe7fea] test2 for pre-commit
 1 file changed, 3 insertions(+)