Skip to content
This repository was archived by the owner on Jun 22, 2025. It is now read-only.

Commit bdd54cb

Browse files
Create developers readme to document setup/testing
1 parent b9eaf62 commit bdd54cb

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README-developers.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Eel Developers
2+
3+
## Setting up a development environment
4+
5+
In order to start developing with Eel you'll need to checkout the code, set up a development and testing environment, and check that everything is in order.
6+
7+
Clone the repository:
8+
```bash
9+
git clone git@github.com:samuelhwilliams/Eel.git
10+
```
11+
12+
Create a dev virtual environment. Your process for doing this may vary, but might look something like this (assuming you have `venv` in a global `.gitignore` file):
13+
14+
```bash
15+
python3 -m venv venv
16+
./venv/bin/activate
17+
```
18+
19+
We support Python 3.6+ so developers should ideally run their tests against the latest minor version of each major version we support from there. Tox is configured to run tests against each major version we support. In order to run tox fully, you will need to install multiple versions of Python. See the pinned minor versions in `.python-version`.
20+
21+
## Running tests
22+
23+
To test Eel against a specific version of Python you have installed, e.g. Python 3.6 in this case, run:
24+
25+
```bash
26+
tox -e py36
27+
```
28+
29+
To test Eel against all supported versions, run the following:
30+
31+
```bash
32+
tox
33+
```

0 commit comments

Comments
 (0)