How to start a server with python framework Pyramid
Tags: python, backend
Published: 2021-08-28 17:26:56

This article shows how to start a simple server with [Pyramid](https://trypyramid.com/).

# Requirements
First, you need the following programs available on your system:
* python3
* pip
* venv

It all should be provided with a python package in your operating system.

# Starting virtual environment
To avoid polluting the global scope with package versions, we can start & use the virtual environment:
```shell
$ python3 -m venv .venv
```

When successful, this command creates `.venv` folder & produces no output.

To switch to the virtual env:
```
$ source .venv/bin/activate
(.venv) $
```

The current console will use `.venv` as the location for packages managed by pip.

# Installing the dependency
```shell
(.venv) $ pip install pyramid                                                                                                                                                              
Collecting pyramid                                                                                                                                                                     
  Downloading pyramid-2.0-py3-none-any.whl (246 kB)                                                                                                                                    
     |████████████████████████████████| 246 kB 2.4 MB/s                                    
Collecting hupper>=1.5                                                                                                                                                                 
  Using cached hupper-1.10.3-py2.py3-none-any.whl (26 kB)                                                                                                                              
Requirement already satisfied: setuptools in ./.venv/lib/python3.8/site-packages (from pyramid) (44.0.0)
Collecting webob>=1.8.3                                                                                                                                                                
  Using cached WebOb-1.8.7-py2.py3-none-any.whl (114 kB)                                                                                                                               
Collecting zope.interface>=3.8.0                                                                                                                                                       
  Using cached zope.interface-5.4.0-cp38-cp38-manylinux2010_x86_64.whl (259 kB)                                                                                                        
Collecting plaster-pastedeploy                                                                                                                                                         
  Using cached plaster_pastedeploy-0.7-py2.py3-none-any.whl (7.8 kB)                                                                                                                   
Collecting translationstring>=0.4                                                          
  Using cached translationstring-1.4-py2.py3-none-any.whl (15 kB)       
Collecting venusian>=1.0                                                                                                                                                               
  Using cached venusian-3.0.0-py3-none-any.whl (13 kB)                                                                                                                                 
Collecting plaster
  Using cached plaster-1.0-py2.py3-none-any.whl (14 kB)
Collecting zope.deprecation>=3.5.0
  Using cached zope.deprecation-4.4.0-py2.py3-none-any.whl (10 kB)
Collecting PasteDeploy>=2.0
  Using cached PasteDeploy-2.1.1-py2.py3-none-any.whl (17 kB)
Installing collected packages: hupper, webob, zope.interface, PasteDeploy, plaster, plaster-pastedeploy, translationstring, venusian, zope.deprecation, pyramid
Successfully installed PasteDeploy-2.1.1 hupper-1.10.3 plaster-1.0 plaster-pastedeploy-0.7 pyramid-2.0 translationstring-1.4 venusian-3.0.0 webob-1.8.7 zope.deprecation-4.4.0 zope.int
erface-5.4.0
```

# Code
I use a slightly modified example from [the documentation](https://docs.pylonsproject.org/projects/pyramid/en/2.0-branch/). `server.py`:
```py
from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response


def hello_world(request):
    return Response('Hello World!')


if __name__ == '__main__':
    HOST = '0.0.0.0'
    PORT = 6543

    with Configurator() as config:
        config.add_route('hello', '/')
        config.add_view(hello_world, route_name='hello')
        app = config.make_wsgi_app()
    server = make_server(HOST, PORT, app)
    print(f'Starting server at {HOST}:{PORT}') 
    server.serve_forever()
```

I moved `HOST` & `PORT` into variables and logged them to the console. Otherwise, the server was quietly working without notifying the user about its presence.

# Running server
```shell
(.venv) $ python3 server.py
Starting server at 0.0.0.0:6543
```
The server works as expected:

![pyramid-hello-world.png](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/035276gbj058zzh2p4k9.png)

# Links
* [repository](https://github.com/marcin-wosinek/pyramid-hello-world)
* [sign up for a free pyramid course](https://www.subscribepage.com/free_gitlab_course)

# Summary
We have seen how to start a simple Pyramid server.