Python AsyncIO data API to manage billions of resources
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs be able to override configuration with command line options (#342) Sep 14, 2018
guillotina Provide more traversal events (#352) Sep 23, 2018
measures Implement transaction strategies to delay starting db transaction to … Dec 29, 2017
.coveragerc fix test coverage Apr 27, 2018
.dockerignore implement docker builds Oct 7, 2017
.gitignore Indexing json file May 24, 2017
.readthedocs.yml Improved docs (#304) Jul 21, 2018
.travis.yml remove 3.7 from travis Sep 23, 2018
CHANGELOG.rst Back to development: 4.2.1 Sep 23, 2018
Dockerfile On content creation, reduce db lookups (#250) Apr 17, 2018
LICENSE BSD license Nov 17, 2016
MANIFEST.in ship Executioner with Guillotina (#311) Jul 23, 2018
Makefile On content creation, reduce db lookups (#250) Apr 17, 2018
README.rst ship Executioner with Guillotina (#311) Jul 23, 2018
VERSION Back to development: 4.2.1 Sep 23, 2018
_cockroach-split-ranges.py On content creation, reduce db lookups (#250) Apr 17, 2018
_cockroachdb-createdb.py Fix cockroach integration and provide travis support for cockroach (#85) May 22, 2017
buildout-docs.cfg Updates to docs and training (#142) Oct 14, 2017
config-cockroach.json ship Executioner with Guillotina (#311) Jul 23, 2018
config-dummy.yaml Move static guillotina assets into python package (#348) Sep 19, 2018
config.yaml Move static guillotina assets into python package (#348) Sep 19, 2018
docker-compose.yml Recover when postgresql gets restarted (#118) Aug 7, 2017
docker_push auto create docker image Mar 10, 2018
docs-requirements.txt bump docs theme Jul 23, 2018
performance-data.md 2.0/Master: various performance improvements and some API changes (#167) Oct 30, 2017
pytest.ini Skiping tests on cookiecutter Jul 25, 2018
requirements.txt upgrade asyncpg (#298) Sep 20, 2018
setup.cfg implement mypy (#284) Jun 7, 2018
setup.py make sure ApplicationRoot knows what loop it is used with (#338) Sep 12, 2018

README.rst

Introduction

https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat https://travis-ci.org/plone/guillotina.svg?branch=master Test Coverage Python Versions 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

Quickstart

We use pip:

pip install guillotina

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:

g

Then...

curl http://localhost:8080

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

You can also navigate in your Guillotina server with its built-in web admin interface by visiting http://localhost:8080/+admin/.

Getting started with development

Using pip:

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

Run tests

We're using pytest:

./bin/pytest guillotina

and for test coverage:

./bin/pytest --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 \
    guillotina/guillotina:latest \
    g -c '{"databases": [{"db": {"storage": "postgresql", "dsn": "postgres://guillotina:@postgres/guillotina"}}], "root_user": {"password": "root"}}'

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