File: usage.rst

package info (click to toggle)
python-trame-server 3.6.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 480 kB
  • sloc: python: 4,075; javascript: 5; sh: 4; makefile: 3
file content (26 lines) | stat: -rw-r--r-- 431 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
Usage
=====

.. _installation:

Installation
------------

To use Trame Server, first install it using pip:

.. code-block:: console

   (.venv) $ pip install trame-server

Running
-------

To create a server, you can instantiate a ``Server`` object:

.. autoclass:: trame_server.Server

The ``name`` parameter can be used to specify the server name. For example:

>>> server = Server(name="my_server")
>>> server.name
'my_server'