Skip to content

Commit 9ad6714

Browse files
authored
fix dev install docs (#82)
* add developer setup section to contribution guide * add env installation instructions * add developer installation instructions * add how to run tests section * improve tests instructions * add use the CLI section on the contributing page --------- Co-authored-by: Fabio Pliger <[email protected]>
1 parent 701fec6 commit 9ad6714

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,44 @@
11
# Contribution guide for developers
22

3+
## Developer setup
4+
5+
Git clone the repository:
6+
7+
```shell
8+
git clone https://github.com/pyscript/pyscript.git
9+
```
10+
11+
(Recommended) Upgrade local pip:
12+
13+
```shell
14+
pip install --upgrade pip
15+
```
16+
17+
Make a virtualenv and activate it:
18+
19+
```shell
20+
python -m venv .venv
21+
. .venv/bin/activate
22+
```
23+
24+
Install your local enviroment dependencies
25+
26+
```shell
27+
pip install -e ".[dev]"
28+
```
29+
30+
## Use the CLI
31+
32+
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](README.md)
33+
34+
## Run the tests
35+
36+
After setting up your developer enviroment, you can run the tests with the following command from the root directory:
37+
38+
```shell
39+
pytest .
40+
```
41+
342
## Documentation
443

544
### Install the documentation dependencies

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,17 @@ Quickly wrap Python scripts into a HTML template, pre-configured with [PyScript]
1515

1616
## Installation
1717

18+
### Using Pip
19+
1820
```shell
1921
$ pip install pyscript
2022
```
2123

24+
### Installing the developer setup from the a repository clone
25+
26+
27+
[see the Developer setup section on CONTRIBUTING page](CONTRIBUTING.md)
28+
2229
## Usage
2330

2431
### Embed a Python script into a PyScript HTML file

0 commit comments

Comments
 (0)