Skip to content

Commit

Permalink
Merge pull request #537 from tableau/add-to-docs-run-local-tabpy
Browse files Browse the repository at this point in the history
Add docs describing how to run local TabPy
  • Loading branch information
dleskosky committed Jan 19, 2022
2 parents 17f8ecf + 61358ca commit b4f4014
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
16 changes: 16 additions & 0 deletions docs/server-install.md
Expand Up @@ -47,3 +47,19 @@ tabpy --config=path/to/my/config/file.conf
It is highly recommended to use Python virtual environment for running TabPy.
Check the [Running TabPy in Python Virtual Environment](tabpy-virtualenv.md) page
for more details.

## Starting a Local TabPy Project

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):

```sh
pip install -e .
```

Then start TabPy just like it was mentioned earlier

```sh
tabpy
```
23 changes: 20 additions & 3 deletions docs/tabpy-virtualenv.md
Expand Up @@ -33,10 +33,27 @@ To run TabPy in Python virtual environment follow the steps:
```

4. Run TabPy:
1. Default TabPy

```sh
tabpy
```
```sh
tabpy
```

2. Local TabPy

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:

```sh
pip install -e .
```

Then start TabPy just like it was mentioned earlier

```sh
tabpy
```

5. To deactivate virtual environment run:

Expand Down

0 comments on commit b4f4014

Please sign in to comment.