Skip to content

Commit

Permalink
docs: detail install versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
FlickerSoul committed Nov 29, 2023
1 parent 926e6cb commit 7e05376
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ GAP is a tool that allows you to create a Gradescope autograder from a decorator

Install from PyPI
```bash
pip install gapper
pip install gapper~=1.3.0
```

For detailed instruction, please read [the documentation page](https://gapper.universe.observer/Tutorials/Getting-Started/#workflow-brief)
Expand Down
7 changes: 6 additions & 1 deletion docs/Tutorials/Detailed-Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ The python version required is `>=3.12.0`.

You can either install from PyPI
```bash
pip install gapper
pip install gapper~=1.3.0
```

or install using poetry
```bash
poetry add gapper~=1.3.0
```

or install from source
Expand Down
4 changes: 2 additions & 2 deletions docs/Tutorials/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ If you want to use gapper and thus the virtual environment again, simply call `s
///

```bash
pip install gapper
pip install gapper~=1.3.0
```

### Create Autograder
Expand All @@ -127,7 +127,7 @@ def print_digits(n: int) -> None:
print_digits(n // 10)
```

First, you need to install `gapper` by running `pip install gapper` in your terminal (the minimal Python version is 3.12.0). Once it's installed, you can import `problem` from `gapper` and invoke it as a decorator, like the following. This will transform the solution into a problem operated by the autograder. The `check_stdout` flag instructs the autograder to check `stdout` output from the `print` function.
First, you need to install `gapper` by running `pip install gapper~=1.3.0` in your terminal (the minimal Python version is 3.12.0). Once it's installed, you can import `problem` from `gapper` and invoke it as a decorator, like the following. This will transform the solution into a problem operated by the autograder. The `check_stdout` flag instructs the autograder to check `stdout` output from the `print` function.

```python
# print_digits.py
Expand Down

0 comments on commit 7e05376

Please sign in to comment.