.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat :target: http://guillotina.readthedocs.io/en/latest/
.. image:: https://travis-ci.org/plone/guillotina.svg?branch=master :target: https://travis-ci.org/plone/guillotina
.. image:: https://codecov.io/gh/plone/guillotina/branch/master/graph/badge.svg :target: https://codecov.io/gh/plone/guillotina/branch/master :alt: Test Coverage
.. image:: https://img.shields.io/pypi/pyversions/guillotina.svg :target: https://pypi.python.org/pypi/guillotina/ :alt: Python Versions
.. image:: https://img.shields.io/pypi/v/guillotina.svg :target: https://pypi.python.org/pypi/guillotina
.. image:: https://img.shields.io/pypi/l/guillotina.svg :target: https://pypi.python.org/pypi/guillotina/ :alt: License
.. image:: https://badges.gitter.im/plone/guillotina.png :target: https://gitter.im/plone/guillotina :alt: Chat
.. image:: https://img.shields.io/docker/cloud/build/plone/guillotina :target: https://hub.docker.com/r/guillotina/guillotina :alt: Docker Cloud Build Status
Please read the detailed docs <http://guillotina.readthedocs.io/en/latest/>_
This is the working project of the next generation Guillotina server based on asyncio.
We use pip
.. code-block:: shell
pip install guillotina
If you don't have a PostgreSQL server to play with, you can run one with Docker.
Download and start the Docker container by running
.. code-block:: shell
make run-postgres
To run the server
.. code-block:: shell
g
Then...
.. code-block:: shell
curl http://localhost:8080
Or, better yet, use Postman <https://www.getpostman.com/>_ 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/.
Read more Guillotina-Heroku <https://github.com/guillotinaweb/guillotina-heroku>_.
.. image:: https://www.herokucdn.com/deploy/button.svg :target: https://www.heroku.com/deploy?template=https://github.com/guillotinaweb/guillotina-heroku
Using pip (requires Python > 3.7)
.. code-block:: shell
git clone git@github.com:plone/guillotina.git
cd guillotina
python3.7 -m venv .
./bin/pip install -r requirements.txt
./bin/pip install -r contrib-requirements.txt
./bin/pip install -e '.[test]'
./bin/pre-commit install
We're using pytest <https://docs.pytest.org/en/latest/>_
.. code-block:: shell
./bin/pytest guillotina
and for test coverage
.. code-block:: shell
./bin/pytest --cov=guillotina guillotina/
With file watcher...
.. code-block:: shell
./bin/ptw guillotina --runner=./bin/py.test
To run tests with cockroach db
.. code-block:: shell
USE_COCKROACH=true ./bin/pytest guillotina
Default root access can be done with AUTHORIZATION header : Basic root:root
You can also run Guillotina with Docker!
First, run PostgreSQL
.. code-block:: shell
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
.. code-block:: shell
docker run --rm -it \
--link=postgres -p 127.0.0.1:8080:8080 \
plone/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
Join us to talk about Guillotina at https://gitter.im/plone/guillotina
Fix: Index full object after move it [rboixaderg]
Chore: Update multidict dependency [rboixaderg]
Fix not checking if the ID is valid when duplicating a resource [masipcat]
Fix content.async_get() catches KeyError exceptions unrelated to txn.get_child() [masipcat]
Deps: replace aioredis with redis-py [masipcat]
Deps: updated flake8 so it won't depend on 'importlib-metadata<5' [masipcat]
Fix path__starts. Add a slash when parsing the path of the query if the context of the search is not the container, to avoid getting the results of contexts that starts with the same path. [nilbacardit26]
Adding render_options when registering a user. [nilbacardit26]
Adding OrderedDict field, and exposing @orderImages to the images' api to order the keys of a field [nilbacardit26]
Fix Pillow dependency [bloodbare]
Breaking change: guillotina futures won't have the txn set anymore. [masipcat]
Fix @pytest.mark.app_settings modified original settings dictionary [masipcat]
Fix previous change in mailer utility [masipcat]
Improve error logging in futures [masipcat]
Documentation: Enhance search endpoint documentation [ksuess]
Documentation: Add info about catalog_max_results [ksuess]
Add a dict parameter render_options to pass custom values to
rendered template in EmailValidationUtility
[jotare]
Some fixes and improvements to the new TransactionConnectionContextManager [masipcat]
Port the following changes:
Remove db transaction strategy support
Try not to reserve connection when possible [vangheem]
Black to 21.10b0 version [bloodbare]
Add the possibility of configuring the ttl of the email_validation using app_settings["ttl_email_validation"] in the utility of the email_validation. By default is 3660s. [nilbacardit26]
Fix docs: Create group with id/name [ksuess]
doc: installation: fix duplicated line and link to contrib/dbusers [jotare]
Add support for Python 3.10 [masipcat]
Reimplemented IRedisUtility to adapt to aioredis v2.0 breaking changes [masipcat]
Removed argument 'loop' from utilities initialization (following Python 3.10 changes) [masipcat]
Upgraded dev dependencies [masipcat]
Fix searching by SearchableText [frapell]
Fix vocabulray country code AN
Mask Textline field to recover masked values on get [bloodbare]
Fix navigate_to() crashes with 'AttributeError' when traversing to a non-folderish object [masipcat]
...
You are seeing a truncated changelog.
You can read the changelog file <https://github.com/plone/guillotina/blob/master/CHANGELOG.rst>_
for a complete list.
FAQs
asyncio REST API Resource database
We found that guillotina demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.