Skip to content

Commit b4f4014

Browse files
authored
Merge pull request #537 from tableau/add-to-docs-run-local-tabpy
Add docs describing how to run local TabPy
2 parents 17f8ecf + 61358ca commit b4f4014

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

docs/server-install.md

+16
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,19 @@ 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,
54+
use pip to create a package from your local TabPy project
55+
and install it within that directory (preferably a virtual environment):
56+
57+
```sh
58+
pip install -e .
59+
```
60+
61+
Then start TabPy just like it was mentioned earlier
62+
63+
```sh
64+
tabpy
65+
```

docs/tabpy-virtualenv.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,27 @@ 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,
45+
use pip to create a package from your local TabPy project and install
46+
it within that directory:
47+
48+
```sh
49+
pip install -e .
50+
```
51+
52+
Then start TabPy just like it was mentioned earlier
53+
54+
```sh
55+
tabpy
56+
```
4057

4158
5. To deactivate virtual environment run:
4259

0 commit comments

Comments
 (0)