httpx/docs/contributing.md

1.0 KiB

Contributing

You are welcome to contribute with HTTPX, read this guide carefully to understand how to setup your environment.

Development

To start developing HTTPX create a fork of the httpx repository on GitHub.

Then clone your fork with the following command replacing YOUR-USERNAME with your GitHub username:

$ git clone https://github.com/YOUR-USERNAME/httpx

Testing

We use nox as testing tool, so before testing make sure you have it installed at your system.

You can install nox with:

$ python3 -m pip install --user nox

Or if you prefer to keep it into an isolated environment you can install it using pipx:

$ pipx install nox

Now with nox installed you can run the tests by running:

$ nox

!!! warning The test suite spawns a testing server at the port 8000. Make sure this isn't being used, so the tests can run properly.