Metadata-Version: 2.1
Name: Flask-Camp
Version: 0.0.5
Summary: Full featured (but generic) headless API for wikis
Author-email: Charles de Beauchesne <charles.de.beauchesne@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Framework :: Flask
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENCE

flask-camp is a flask extension that build an full featured (but generic) wiki REST API.

## Installation

```bash
pip install flask-camp
```

## Usage

```python
from flask import Flask
from flask_camp import RestApi

app = Flask(__name__)
api = RestApi(app)
```

## Run your app

You'll need a running [redis](https://redis.io/) on port 6379 and a [postgresql](https://www.postgresql.org/) on port 5432. If you don't have it, just run `flask_camp dev_env` before running your app (requires [docker](https://www.docker.com/)).

```bash
flask --debug run
```

All possible endpoints with a short explanation are visible on root page: http://localhost:5000
