Skip to content

www3838438/guillotina

 
 

Repository files navigation

Introduction

image

image

Test Coverage

Python Versions

image

License

Chat

Please read the detailed docs

This is the working project of the next generation Guillotina server based on asyncio.

Dependencies

  • python >= 3.6
  • postgresql >= 9.6

Getting started with development

Using pip:

./bin/pip install requirements.txt ./bin/pip install -e .[test]

Run postgresql

If you don't have a postgresql server to play with, you can run one easily with docker.

Download and start the docker container by running:

make run-postgres

Run the server

To run the server:

./bin/guillotina

Then...

curl http://localhost:8080

Or, better yet, use postman to start playing with API.

Run tests

We're using py.test:

./bin/py.test guillotina

and for test coverage:

./bin/py.test --cov=guillotina guillotina/

With file watcher...

./bin/ptw guillotina --runner=./bin/py.test

To run tests with cockroach db:

USE_COCKROACH=true ./bin/pytest guillotina

Default

Default root access can be done with AUTHORIZATION header : Basic root:root

Docker

You can also run Guillotina with Docker!

First, run postgresql:

docker run --rm \
    -e POSTGRES_DB=guillotina \
    -e POSTGRES_USER=guillotina \
    -p 127.0.0.1:5432:5432 \
    --name postgres \
    postgres:9.6

Then, run guillotina:

docker run --rm -it \
    --link=postgres \
    -p 127.0.0.1:8080:8080 \
    -v $(echo $PWD):/g \
    guillotina/guillotina \
    --name g \
    g -c /g/config.yaml

This assumes you have a config.yaml in your current working directory

Chat

Join us to talk about Guillotina at https://gitter.im/plone/guillotina

About

asyncio transactional server to build REST API / Websocket

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%