CONTRIBUTING.md

Contributing to Native Authenticator

Welcome! As a Jupyter project, you can follow the Jupyter contributor guide.

Make sure to also follow Project Jupyter's Code of Conduct for a friendly and welcoming collaborative environment.

Setting up a development environment

Install requirements

First install JupyterHub. Then you can install de development requirements for Native Authenticator:

pip install -r dev-requirements.txt

And then installing Native Authenticator from master branch:

pip install -e .

Configure pre-commit

pre-commit is a tool we use to validate code and autoformat it. The kind of validation and auto formatting can be inspected via the .pre-commit-config.yaml file.

As the name implies, pre-commit can be configured to run its validation and auto formatting just before you make a commit. By configuring it to do so, you can avoid having to have a separate commit later that applies auto formatting.

To configure pre-commit to run act before you commit, you can run the following command from the root of this repository next to the .pre-commit-config.yaml file.

pre-commit install

Running your local project

For developing the Native Authenticator, you can start a JupyterHub server using dev-jupyterhub_config.py.

jupyterhub -f dev-jupyterhub_config.py

Runing tests

On the project folder you can run tests by using pytest

pytest