|
2 | 2 |
|
3 | 3 | ## Developer setup
|
4 | 4 |
|
5 |
| -Git clone the repository: |
| 5 | +* Create a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the [PyScript-CLI github repository](https://github.com/pyscript/pyscript-cli/fork) to your own GitHub account. |
6 | 6 |
|
7 |
| -```shell |
8 |
| -git clone https://github.com/pyscript/pyscript-cli.git |
9 |
| -``` |
| 7 | +* [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your newly forked version of the PyScript-CLI repository onto your local development machine. For example, use this command in your terminal: |
10 | 8 |
|
11 |
| -(Recommended) Upgrade local pip: |
| 9 | + ```sh |
| 10 | + git clone https://github.com/<YOUR USERNAME>/pyscript-cli |
| 11 | + ``` |
12 | 12 |
|
13 |
| -```shell |
14 |
| -pip install --upgrade pip |
15 |
| -``` |
| 13 | + > **WARNING**: In the URL for the forked PyScript-CLI repository, remember to replace |
| 14 | + `<YOUR USERNAME>` with your actual GitHub username. |
16 | 15 |
|
17 |
| -Make a virtualenv and activate it: |
| 16 | +* Change into the root directory of your newly cloned `pyscript-cli` repository: |
18 | 17 |
|
19 |
| -```shell |
20 |
| -python -m venv .venv |
21 |
| -source .venv/bin/activate |
22 |
| -``` |
| 18 | + ```sh |
| 19 | + cd pyscript-cli |
| 20 | + ``` |
23 | 21 |
|
24 |
| -Install your local enviroment dependencies |
| 22 | +* Add the original PyScript-CLI repository as your `upstream` to allow you to keep your own fork up-to-date with the latest changes: |
25 | 23 |
|
26 |
| -```shell |
27 |
| -pip install -e ".[dev]" |
28 |
| -``` |
| 24 | + ```sh |
| 25 | + git remote add upstream https://github.com/pyscript/pyscript-cli.git |
| 26 | + ``` |
| 27 | + |
| 28 | +* If the above fails, try this alternative: |
| 29 | + |
| 30 | + ```sh |
| 31 | + git remote remove upstream |
| 32 | + ``` |
| 33 | + |
| 34 | + ```sh |
| 35 | + git remote add upstream [email protected]:pyscript/pyscript-cli.git |
| 36 | + ``` |
| 37 | + |
| 38 | +* Pull in the latest changes from the main `upstream` PyScript repository: |
| 39 | + |
| 40 | + ```sh |
| 41 | + git pull upstream main |
| 42 | + ``` |
| 43 | + |
| 44 | +* (Recommended) Upgrade local pip: |
| 45 | + |
| 46 | + ```shell |
| 47 | + pip install --upgrade pip |
| 48 | + ``` |
| 49 | + |
| 50 | +* Make a virtualenv and activate it: |
| 51 | + |
| 52 | + ```shell |
| 53 | + python -m venv .venv |
| 54 | + source .venv/bin/activate |
| 55 | + ``` |
| 56 | + |
| 57 | +* Install your local enviroment dependencies |
| 58 | + |
| 59 | + ```shell |
| 60 | + pip install -e ".[dev]" |
| 61 | + ``` |
29 | 62 |
|
30 | 63 | ## Use the CLI
|
31 | 64 |
|
|
0 commit comments