Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabienarcellier/blueprint-writer-framework
blueprint to implement writer framework app - low code with python
https://github.com/fabienarcellier/blueprint-writer-framework
blueprint
Last synced: 25 days ago
JSON representation
blueprint to implement writer framework app - low code with python
- Host: GitHub
- URL: https://github.com/fabienarcellier/blueprint-writer-framework
- Owner: FabienArcellier
- License: mit
- Created: 2023-10-04T14:17:28.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-23T02:28:30.000Z (4 months ago)
- Last Synced: 2024-08-23T03:34:38.237Z (4 months ago)
- Topics: blueprint
- Language: Python
- Homepage:
- Size: 242 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## blueprint-writer-framework
[](https://github.com/FabienArcellier/blueprint-streamsync/actions/workflows/main.yml)
blueprint to implement a simple spike with [writer-framework](https://github.com/writer/writer-framework)
* prototype quick application with low code UI
* build demo for writer-framework
* ...
## Getting started
### Run in gitpod
[gitpod](https://www.gitpod.io/) can be used as an IDE. You can load the code inside to try the code.
[](https://gitpod.io/#https://github.com/FabienArcellier/blueprint-streamsync)
### Run in local
1. clone this repository
2. remove .git directory
* [prepare the blueprint to start a new project](./prepare%20the%20blueprint.md)
```bash
alfred edit
```
## The latest version
You can find the latest version to ...
```bash
git clone https://github.com/FabienArcellier/blueprint-writer-framework.git
```
## Developper guideline
### Add a dependency
``bash
poetry add requests
``
### Install development environment
Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.
```bash
poetry install
```
### Update release dependencies
Use make to instanciate a python virtual environment in ./venv and freeze
dependencies version
```bash
poetry update update
```
### Activate the python environment
When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :
```bash
poetry shell
```
### Run the continuous integration process
Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.
```bash
$ poetry run alfred ci
```
### Rebuild the blueprint from scratch
I have to regularly rebuild it to update dependencies.
* [maintain this blueprint](./maintain%20this%20blueprint.md)
## Contributors
* Fabien Arcellier
## License
MIT License
Copyright (c) 2018-2024 Fabien Arcellier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.