Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinissimus/guillotina_evolution
Guillotina addon to write migrations/evolutions
https://github.com/vinissimus/guillotina_evolution
asyncio guillotina
Last synced: about 1 month ago
JSON representation
Guillotina addon to write migrations/evolutions
- Host: GitHub
- URL: https://github.com/vinissimus/guillotina_evolution
- Owner: vinissimus
- License: gpl-3.0
- Created: 2018-12-21T14:31:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-09T22:39:50.000Z (almost 5 years ago)
- Last Synced: 2024-11-08T14:19:48.242Z (about 2 months ago)
- Topics: asyncio, guillotina
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# guillotina_evolution
[](https://travis-ci.org/vinissimus/guillotina_evolution) [](https://badge.fury.io/py/guillotina-evolution) [](https://codecov.io/gh/vinissimus/guillotina_evolution/branch/master) 
Addon that provides evolutions/migrations to create or update objects in your Guillotina containers.
## Install
```console
pip install guillotina_evolution
```
## Configure
Add the following values in `app_settings`:
```python
app_settings = {
"applications": [
"guillotina_evolution",
],
"commands": {
"g-evolve": "guillotina_evolution.commands.evolve.EvolveCommand",
},
```
Configure your app addon to initialize guillotina_evolution when is installed:
```python
from guillotina.component import get_utility
from guillotina_evolution.interfaces import IEvolutionUtility
@configure.addon(name="app", title="Your guillotina app")
class ManageAddon(Addon):
@classmethod
async def install(cls, container, request):
utility = get_utility(IEvolutionUtility)
utility.install() # initialize current generation with the greatest registered generation
# ...
```
## Write your evolver
Create a folder `evolutions` inside your guillotina app that contains the following files:
`app/evolutions/__init__.py`
```python
from .r20190118 import * # noqa
# Don't forget to add all rXXXXXXXX.py!
```
`app/evolutions/r20190118.py`
```python
from guillotina_evolution.utils import register_evolution
@register_evolution(1)
async def evolver(container):
async for item in container.async_items():
item.title = item.title + ' (Migrated)'
item.register()
```
Update the `includeme()` of your app:
`app/__init__.py`
```python
def includeme(root):
# ...
configure.scan("app.evolutions")
```
## Evolve
Run guillotina command `g-evolve` to run your migrations.
```console
g -c config.yaml g-evolve
```