Skip to content

Commit 2a2718e

Browse files
committed
added some info about running local tabpy to docs
1 parent 7318eb6 commit 2a2718e

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

docs/server-install.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,17 @@ tabpy --config=path/to/my/config/file.conf
4747
It is highly recommended to use Python virtual environment for running TabPy.
4848
Check the [Running TabPy in Python Virtual Environment](tabpy-virtualenv.md) page
4949
for more details.
50+
51+
## Starting a Local TabPy Project
52+
53+
To create a version of TabPy that incorporates locally-made changes, use pip to create a package from your local TabPy project and install it within that directory (preferably a virtual environment):
54+
55+
```sh
56+
pip install -e .
57+
```
58+
59+
Then start TabPy just like it was mentioned earlier
60+
61+
```sh
62+
tabpy
63+
```

docs/tabpy-virtualenv.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,25 @@ To run TabPy in Python virtual environment follow the steps:
3333
```
3434

3535
4. Run TabPy:
36+
1. Default TabPy
3637

37-
```sh
38-
tabpy
39-
```
38+
```sh
39+
tabpy
40+
```
41+
42+
2. Local TabPy
43+
44+
To create a version of TabPy that incorporates locally-made changes, use pip to create a package from your local TabPy project and install it within that directory:
45+
46+
```sh
47+
pip install -e .
48+
```
49+
50+
Then start TabPy just like it was mentioned earlier
51+
52+
```sh
53+
tabpy
54+
```
4055

4156
5. To deactivate virtual environment run:
4257

0 commit comments

Comments
 (0)