CONTRIBUTING.md

Contribution guide for developers

Developer setup

Git clone the repository:

git clone https://github.com/pyscript/pyscript.git

(Recommended) Upgrade local pip:

pip install --upgrade pip

Make a virtualenv and activate it:

python -m venv .venv
source .venv/bin/activate

Install your local enviroment dependencies

pip install -e ".[dev]"

Use the CLI

It is now possible to normally use the CLI. For more information on how to use it and it's commands, see the Use the CLI section of the README

Run the tests

After setting up your developer enviroment, you can run the tests with the following command from the root directory:

pytest .

Documentation

Install the documentation dependencies

To get started, you will need to install the documentation dependencies from the project root:

pip install -e ".[docs]"

Generate the docs in live mode

The live mode will allow you to generate the documentation with live reload.

From the project root, run the following command :

make -C docs live

Or, alternately, navigate to the docs directory and run:

make live

Either of the above commands should launch a live dev server and you will be able to view the docs in your browser. As the files are updated, the docs should be refreshed.

Generate static docs

If you don't want to use the live reload mode, simply replace either command above with html, e.g.:

make -C docs html