Skip to content

Commit

Permalink
Clarified instructions for source vs distribution
Browse files Browse the repository at this point in the history
  • Loading branch information
WillAyd committed Jun 28, 2018
1 parent 4e2c197 commit 6777d26
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,18 @@ TabPy suggests using [Pipenv](https://docs.pipenv.org) to configure and manage y
pipenv install -dev
```

This will create a dedicated virtual environment containing all of the development requirements, which you can subsequently activate to get started:
This will create a dedicated virtual environment containing all of the development requirements.

## Starting the Server

From the project root, activate the virtual environment you created above via:

```sh
pipenv shell
```

Thereafter, simply navigate to tabpy-server/tabpy-server and run:

```sh
python tabpy.py
```
12 changes: 12 additions & 0 deletions server.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ Change settings by:

The template file is not used by the application but is used for documenting which settings may be modified and what the defaults are if no config file or environment variables are set.

## Starting the Server

If you have installed a pre-built distribution from PyPy you will need to navigate to the source code contained in _site\\_packages_ and go subsequently into the tabpy-server/tabpy-server directory. From there run:

```sh
python tabpy.py
```

to start up a server.

If working with the source code refer to the instructions located in the [Contributing Guide](CONTRIBUTING.md).

## REST Interfaces

The server process exposes several REST APIs to get status and to execute Python code and query deployed methods.
Expand Down

0 comments on commit 6777d26

Please sign in to comment.