Introduction
============
.. 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.
Dependencies
------------
* Python >= 3.7
* PostgreSQL >= 9.6
Quickstart
----------
We use pip
.. code-block:: shell
pip install guillotina
Run PostgreSQL
--------------
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
Run the server
--------------
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/.
Deploy on Heroku
----------------
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
Getting started with development
--------------------------------
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
Run tests
---------
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
-------
Default root access can be done with AUTHORIZATION header : Basic root:root
Docker
------
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
Chat
----
Join us to talk about Guillotina at https://gitter.im/plone/guillotina
CHANGELOG
=========
7.0.3 (2024-10-01)
------------------
- Calling register and notify when sorting OrderedDicts
- Calling register and notify when deleting file keys
[nilbacardit26]
7.0.2 (2024-01-23)
------------------
- Dummy Release [bloodbare]
7.0.1 (2024-01-23)
------------------
- Being able to use schema.Time [nilbacardit26]
- Feat: Add metadata info to workflows
- Fix: Update workflow vocabulary name
- Feat: Update workflow vocabulary title attribute to use metadata
[rboixaderg]
7.0.0 (2023-12-06)
------------------
- BREAKING CHANGE: Passging sql_copy_from_where and jit parameters to
asyncpg.connection.ServerCapabilities and pinning asyncpg in
requirements to 0.29.0. Dropping 3.7.0 python support
[nilbacardit26]
6.4.5 (2023-11-28)
------------------
- Fix: Index full object after move it
[rboixaderg]
- Chore: Update multidict dependency
[rboixaderg]
6.4.4 (2023-11-20)
------------------
- Removing implements import in components/interfaces.py
[nilbacardit26]
6.4.3 (2023-10-11)
------------------
- 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]
6.4.2 (2022-08-25)
------------------
- Being able to call do_action with super powers in the Workflow
utility
[nilbacardit26]
6.4.1 (2022-07-27)
------------------
- Fix build count query, PG catalog, ignore null and format tuple type.
[rboixaderg]
6.4.0 (2022-04-12)
------------------
- Fix PubSub utility stuck in infinite loop when Redis connection is interrupted
[masipcat]
6.4.0rc3 (2022-03-16)
---------------------
- 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]
6.4.0rc2 (2021-11-22)
---------------------
- Nothing changed yet.
6.4.0rc1 (2021-11-22)
---------------------
- 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]
6.4.0rc0 (2021-10-20)
---------------------
- 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
6.3.15 (2021-08-05)
-------------------
- fix: Add MIMEMultipart('alternative') to attach message in parent MIMEMultipart to render only html body.
[rboixaderg]
6.3.14 (2021-08-04)
-------------------
- feat: Change MIMEMultipart 'alternative' to 'mixed'. Outlook and Thunderbird not recieve attachment when use 'alternative'
- chore: fix version aioredis 1.3.1
[rboixaderg]
6.3.13 (2021-07-05)
-------------------
- Mask Textline field to recover masked values on get
[bloodbare]
- Fix navigate_to() crashes with 'AttributeError' when traversing to a non-folderish object
[masipcat]
6.3.12 (2021-07-01)
-------------------
- shell: import 'app_settings'. Fix typo
- doc: Fix example app and other small fixes
[jianaijun]
- feat: Add null and not null operator in int, float and timestamp types in pgcatalog
[rboixaderg]
6.3.11 (2021-06-10)
-------------------
- Add is not null operator Search pgcatalog
- Fix order by int and float Search pgcatalog
[rboixaderg]
...
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/plone/guillotina",
"name": "guillotina",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": null,
"keywords": "asyncio, REST, Framework, transactional, asgi",
"author": "Ramon Navarro Bosch & Nathan Van Gheem",
"author_email": "ramon@plone.org",
"download_url": "https://files.pythonhosted.org/packages/ea/66/c83f5c61b21668ebc69d534633be2a8e3b4a6b803066b0df27118dbd42ed/guillotina-7.0.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat\n :target: http://guillotina.readthedocs.io/en/latest/\n\n.. image:: https://travis-ci.org/plone/guillotina.svg?branch=master\n :target: https://travis-ci.org/plone/guillotina\n\n.. image:: https://codecov.io/gh/plone/guillotina/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/plone/guillotina/branch/master\n :alt: Test Coverage\n\n.. image:: https://img.shields.io/pypi/pyversions/guillotina.svg\n :target: https://pypi.python.org/pypi/guillotina/\n :alt: Python Versions\n\n.. image:: https://img.shields.io/pypi/v/guillotina.svg\n :target: https://pypi.python.org/pypi/guillotina\n\n.. image:: https://img.shields.io/pypi/l/guillotina.svg\n :target: https://pypi.python.org/pypi/guillotina/\n :alt: License\n\n.. image:: https://badges.gitter.im/plone/guillotina.png\n :target: https://gitter.im/plone/guillotina\n :alt: Chat\n\n.. image:: https://img.shields.io/docker/cloud/build/plone/guillotina\n :target: https://hub.docker.com/r/guillotina/guillotina\n :alt: Docker Cloud Build Status\n\nPlease `read the detailed docs <http://guillotina.readthedocs.io/en/latest/>`_\n\n\nThis is the working project of the next generation Guillotina server based on asyncio.\n\n\nDependencies\n------------\n\n* Python >= 3.7\n* PostgreSQL >= 9.6\n\n\nQuickstart\n----------\n\nWe use pip\n\n.. code-block:: shell\n\n pip install guillotina\n\n\nRun PostgreSQL\n--------------\n\nIf you don't have a PostgreSQL server to play with, you can run one with Docker.\n\nDownload and start the Docker container by running\n\n.. code-block:: shell\n\n make run-postgres\n\n\n\nRun the server\n--------------\n\nTo run the server\n\n.. code-block:: shell\n\n g\n\n\nThen...\n\n.. code-block:: shell\n\n curl http://localhost:8080\n\n\nOr, better yet, use `Postman <https://www.getpostman.com/>`_ to start playing with API.\n\nYou can also navigate in your Guillotina server with its built-in web admin interface by visiting http://localhost:8080/+admin/.\n\nDeploy on Heroku\n----------------\n\nRead more `Guillotina-Heroku <https://github.com/guillotinaweb/guillotina-heroku>`_.\n\n.. image:: https://www.herokucdn.com/deploy/button.svg\n :target: https://www.heroku.com/deploy?template=https://github.com/guillotinaweb/guillotina-heroku\n\nGetting started with development\n--------------------------------\n\nUsing pip (requires Python > 3.7)\n\n.. code-block:: shell\n\n git clone git@github.com:plone/guillotina.git\n cd guillotina\n python3.7 -m venv .\n ./bin/pip install -r requirements.txt\n ./bin/pip install -r contrib-requirements.txt\n ./bin/pip install -e '.[test]'\n ./bin/pre-commit install\n\n\nRun tests\n---------\n\nWe're using `pytest <https://docs.pytest.org/en/latest/>`_\n\n.. code-block:: shell\n\n ./bin/pytest guillotina\n\nand for test coverage\n\n.. code-block:: shell\n\n ./bin/pytest --cov=guillotina guillotina/\n\nWith file watcher...\n\n.. code-block:: shell\n\n ./bin/ptw guillotina --runner=./bin/py.test\n\n\nTo run tests with cockroach db\n\n.. code-block:: shell\n\n USE_COCKROACH=true ./bin/pytest guillotina\n\nDefault\n-------\n\nDefault root access can be done with AUTHORIZATION header : Basic root:root\n\n\nDocker\n------\n\nYou can also run Guillotina with Docker!\n\n\nFirst, run PostgreSQL\n\n.. code-block:: shell\n\n docker run --rm \\\n -e POSTGRES_DB=guillotina \\\n -e POSTGRES_USER=guillotina \\\n -p 127.0.0.1:5432:5432 \\\n --name postgres \\\n postgres:9.6\n\nThen, run Guillotina\n\n.. code-block:: shell\n\n docker run --rm -it \\\n --link=postgres -p 127.0.0.1:8080:8080 \\\n plone/guillotina:latest \\\n g -c '{\"databases\": [{\"db\": {\"storage\": \"postgresql\", \"dsn\": \"postgres://guillotina:@postgres/guillotina\"}}], \"root_user\": {\"password\": \"root\"}}'\n\n\nThis assumes you have a config.yaml in your current working directory\n\n\nChat\n----\n\nJoin us to talk about Guillotina at https://gitter.im/plone/guillotina\n\n\nCHANGELOG\n=========\n\n7.0.3 (2024-10-01)\n------------------\n\n- Calling register and notify when sorting OrderedDicts\n- Calling register and notify when deleting file keys\n [nilbacardit26]\n\n\n7.0.2 (2024-01-23)\n------------------\n\n- Dummy Release [bloodbare]\n\n\n7.0.1 (2024-01-23)\n------------------\n\n- Being able to use schema.Time [nilbacardit26]\n- Feat: Add metadata info to workflows\n- Fix: Update workflow vocabulary name\n- Feat: Update workflow vocabulary title attribute to use metadata\n [rboixaderg]\n\n\n7.0.0 (2023-12-06)\n------------------\n\n- BREAKING CHANGE: Passging sql_copy_from_where and jit parameters to\n asyncpg.connection.ServerCapabilities and pinning asyncpg in\n requirements to 0.29.0. Dropping 3.7.0 python support\n [nilbacardit26]\n\n6.4.5 (2023-11-28)\n------------------\n\n- Fix: Index full object after move it\n [rboixaderg]\n\n- Chore: Update multidict dependency\n [rboixaderg]\n\n\n6.4.4 (2023-11-20)\n------------------\n\n- Removing implements import in components/interfaces.py\n [nilbacardit26]\n\n\n6.4.3 (2023-10-11)\n------------------\n\n- Fix not checking if the ID is valid when duplicating a resource\n [masipcat]\n\n- Fix content.async_get() catches KeyError exceptions unrelated to txn.get_child()\n [masipcat]\n\n- Deps: replace aioredis with redis-py\n [masipcat]\n\n- Deps: updated flake8 so it won't depend on 'importlib-metadata<5'\n [masipcat]\n\n- Fix path__starts. Add a slash when parsing the path of the query if\n the context of the search is not the container, to avoid getting the\n results of contexts that starts with the same path.\n [nilbacardit26]\n\n- Adding render_options when registering a user.\n [nilbacardit26]\n\n- Adding OrderedDict field, and exposing @orderImages to the images'\n api to order the keys of a field\n [nilbacardit26]\n\n\n6.4.2 (2022-08-25)\n------------------\n\n- Being able to call do_action with super powers in the Workflow\n utility\n [nilbacardit26]\n\n\n6.4.1 (2022-07-27)\n------------------\n\n- Fix build count query, PG catalog, ignore null and format tuple type. \n [rboixaderg]\n\n\n6.4.0 (2022-04-12)\n------------------\n\n- Fix PubSub utility stuck in infinite loop when Redis connection is interrupted\n [masipcat]\n\n\n6.4.0rc3 (2022-03-16)\n---------------------\n\n- Fix Pillow dependency\n [bloodbare]\n\n- Breaking change: guillotina futures won't have the txn set anymore.\n [masipcat]\n\n- Fix @pytest.mark.app_settings modified original settings dictionary\n [masipcat]\n\n- Fix previous change in mailer utility\n [masipcat]\n\n- Improve error logging in futures\n [masipcat]\n- Documentation: Enhance search endpoint documentation\n [ksuess]\n- Documentation: Add info about catalog_max_results\n [ksuess]\n\n- Add a dict parameter `render_options` to pass custom values to\n rendered template in EmailValidationUtility\n [jotare]\n\n6.4.0rc2 (2021-11-22)\n---------------------\n\n- Nothing changed yet.\n\n\n6.4.0rc1 (2021-11-22)\n---------------------\n\n- Some fixes and improvements to the new TransactionConnectionContextManager\n [masipcat]\n\n- Port the following changes:\n- Remove db transaction strategy support\n- Try not to reserve connection when possible\n [vangheem]\n\n- Black to 21.10b0 version\n [bloodbare]\n\n- Add the possibility of configuring the ttl of the email_validation\n using app_settings[\"ttl_email_validation\"] in the utility of the\n email_validation. By default is 3660s.\n [nilbacardit26]\n- Fix docs: Create group with id/name\n [ksuess]\n\n- doc: installation: fix duplicated line and link to contrib/dbusers\n [jotare]\n\n\n6.4.0rc0 (2021-10-20)\n---------------------\n\n- Add support for Python 3.10\n [masipcat]\n- Reimplemented IRedisUtility to adapt to aioredis v2.0 breaking changes\n [masipcat]\n- Removed argument 'loop' from utilities initialization (following Python 3.10 changes)\n [masipcat]\n- Upgraded dev dependencies\n [masipcat]\n\n- Fix searching by SearchableText\n [frapell]\n\n- Fix vocabulray country code AN\n\n6.3.15 (2021-08-05)\n-------------------\n\n- fix: Add MIMEMultipart('alternative') to attach message in parent MIMEMultipart to render only html body.\n [rboixaderg]\n\n6.3.14 (2021-08-04)\n-------------------\n\n- feat: Change MIMEMultipart 'alternative' to 'mixed'. Outlook and Thunderbird not recieve attachment when use 'alternative'\n- chore: fix version aioredis 1.3.1\n [rboixaderg]\n\n\n6.3.13 (2021-07-05)\n-------------------\n\n- Mask Textline field to recover masked values on get\n [bloodbare]\n\n- Fix navigate_to() crashes with 'AttributeError' when traversing to a non-folderish object\n [masipcat]\n\n\n6.3.12 (2021-07-01)\n-------------------\n\n- shell: import 'app_settings'. Fix typo\n- doc: Fix example app and other small fixes\n [jianaijun]\n- feat: Add null and not null operator in int, float and timestamp types in pgcatalog\n [rboixaderg]\n\n\n6.3.11 (2021-06-10)\n-------------------\n\n- Add is not null operator Search pgcatalog\n- Fix order by int and float Search pgcatalog\n [rboixaderg]\n\n\n\n...\n\nYou are seeing a truncated changelog.\n\nYou can read the `changelog file <https://github.com/plone/guillotina/blob/master/CHANGELOG.rst>`_\nfor a complete list.\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "asyncio REST API Resource database",
"version": "7.0.3",
"project_urls": {
"Homepage": "https://github.com/plone/guillotina"
},
"split_keywords": [
"asyncio",
" rest",
" framework",
" transactional",
" asgi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea66c83f5c61b21668ebc69d534633be2a8e3b4a6b803066b0df27118dbd42ed",
"md5": "20979a7d19fe3520ceef14ca74c3db10",
"sha256": "b1729659a3f94b2247f4ca6c7351c5133e28e070d3fa4f7e9a631eb1e4f38f07"
},
"downloads": -1,
"filename": "guillotina-7.0.3.tar.gz",
"has_sig": false,
"md5_digest": "20979a7d19fe3520ceef14ca74c3db10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 7260757,
"upload_time": "2024-10-01T09:45:24",
"upload_time_iso_8601": "2024-10-01T09:45:24.025787Z",
"url": "https://files.pythonhosted.org/packages/ea/66/c83f5c61b21668ebc69d534633be2a8e3b4a6b803066b0df27118dbd42ed/guillotina-7.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 09:45:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plone",
"github_project": "guillotina",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "Cython",
"specs": [
[
"==",
"0.29.24"
]
]
},
{
"name": "asyncpg",
"specs": [
[
">=",
"0.28.0"
]
]
},
{
"name": "cffi",
"specs": [
[
"==",
"1.14.6"
]
]
},
{
"name": "chardet",
"specs": [
[
"==",
"3.0.4"
]
]
},
{
"name": "jsonschema",
"specs": [
[
"==",
"2.6.0"
]
]
},
{
"name": "multidict",
"specs": [
[
"==",
"6.0.4"
]
]
},
{
"name": "pycparser",
"specs": [
[
"==",
"2.20"
]
]
},
{
"name": "pycryptodome",
"specs": [
[
"==",
"3.6.6"
]
]
},
{
"name": "PyJWT",
"specs": [
[
"~=",
"2.1.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.8.2"
]
]
},
{
"name": "PyYaml",
"specs": [
[
">=",
"5.1"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.11.0"
]
]
},
{
"name": "orjson",
"specs": [
[
">=",
"3"
],
[
"<",
"4"
]
]
},
{
"name": "zope.interface",
"specs": [
[
"==",
"5.1.0"
]
]
},
{
"name": "uvicorn",
"specs": [
[
"==",
"0.17.6"
]
]
},
{
"name": "argon2-cffi",
"specs": [
[
"==",
"18.3.0"
]
]
},
{
"name": "backoff",
"specs": [
[
"==",
"1.10.0"
]
]
},
{
"name": "prometheus-client",
"specs": [
[
"==",
"0.8.0"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"3.7.4.3"
]
]
},
{
"name": "types-chardet",
"specs": [
[
"==",
"0.1.5"
]
]
},
{
"name": "types-docutils",
"specs": [
[
"==",
"0.17.0"
]
]
},
{
"name": "types-orjson",
"specs": [
[
"==",
"3.6.0"
]
]
},
{
"name": "types-python-dateutil",
"specs": [
[
"==",
"0.1.6"
]
]
},
{
"name": "types-pytz",
"specs": [
[
"==",
"2021.1.2"
]
]
},
{
"name": "types-PyYAML",
"specs": [
[
"==",
"5.4.6"
]
]
},
{
"name": "types-setuptools",
"specs": [
[
"==",
"57.0.2"
]
]
},
{
"name": "types-toml",
"specs": [
[
"==",
"0.1.5"
]
]
},
{
"name": "types-redis",
"specs": [
[
"==",
"4.3.21"
]
]
}
],
"lcname": "guillotina"
}
JSON
