Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andreafspeziale/nodes

Minimal Flask API to explore a nested set model ⛰️
https://github.com/andreafspeziale/nodes

flask nested-set python3

Last synced: 4 days ago
JSON representation

Minimal Flask API to explore a nested set model ⛰️

Host: GitHub
URL: https://github.com/andreafspeziale/nodes
Owner: andreafspeziale
License: mit
Created: 2024-06-03T21:27:18.000Z (6 months ago)
Default Branch: develop
Last Pushed: 2024-06-12T22:37:33.000Z (5 months ago)
Last Synced: 2024-06-13T21:07:57.397Z (5 months ago)
Topics: flask, nested-set, python3
Language: Python
Homepage:
Size: 118 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Nodes

Minimal Flask API to explore a nested set model.

Check the challenge in the `docs` folder.

![Release)](https://img.shields.io/github/v/release/andreafspeziale/nodes)
![License: MIT](https://img.shields.io/github/license/andreafspeziale/nodes.svg)
![Test](https://github.com/andreafspeziale/nodes/actions/workflows/test.yml/badge.svg)
![Docker](https://github.com/andreafspeziale/nodes/actions/workflows/docker-build-and-push.yml/badge.svg)

## Requirements

The project uses sqlite, so the only requirement is:

- `python3`

## Quickstart

```sh
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
pre-commit install
flask --app nodes run --debug
```
>Go to the browser and try a sample API call like:
`http://127.0.0.1:5000/api/nodes/5/children?language=italian`

## Docker

```sh
docker pull andreafspeziale/nodes-app
docker run -p 8000:8000 --rm andreafspeziale/nodes-app
```
>Go to the browser and try a sample API call like:
`http://127.0.0.1:8000/api/nodes/5/children?language=italian`

### Development

```sh
$ mypy # type check
$ black . # formatting
$ pylint nodes tests # linting
$ pytest # tests
```

## Stay in touch

- Author - [Andrea Francesco Speziale](https://twitter.com/andreafspeziale)

## License

nodes [MIT licensed](LICENSE).