Metadata-Version: 2.1
Name: Bolinette
Version: 0.5.7
Summary: Bolinette, a web framework built on top of Flask
Home-page: https://github.com/TheCaptainCat/bolinette
Author: Pierre Chat
Author-email: pierrechat@outlook.com
License: MIT
Keywords: Flask,Bolinette,Web,Framework
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: aiohttp (==3.7.0)
Requires-Dist: aiohttp-cors (==0.7.0)
Requires-Dist: bcrypt (==3.2.0)
Requires-Dist: Jinja2 (==2.11.2)
Requires-Dist: PyJWT (==1.7.1)
Requires-Dist: pytest (==6.1.1)
Requires-Dist: pytest-aiohttp (==0.3.0)
Requires-Dist: pytz (==2020.1)
Requires-Dist: PyYAML (==5.3.1)
Requires-Dist: requests (==2.24.0)
Requires-Dist: setuptools (==50.3.2)
Requires-Dist: SQLAlchemy (==1.3.20)
Requires-Dist: twine (==3.2.0)
Requires-Dist: typing-extensions (==3.7.4.3)

# Bolinette

Bolinette is a Python web framework built on top of [aiohttp](https://github.com/aio-libs/aiohttp)

## Install

### Prerequisites

Bolinette requires Python 3.9. Get it from the [official sources](https://www.python.org/downloads/). Be sure to
install the pip and virtualenv extensions.

### Create your project folder

```shell script
mkdir my_project && cd my_project
```

### Install Bolinette

With a virtual environment:
```shell script
python3.9 -m venv venv && source venv/bin/activate && pip install pip --upgrade && pip install bolinette
```

Globally, with admin rights:
```shell script
pip install pip --upgrade && pip install bolinette
```

## Use the Bolinette CLI

*The CLI is work in progress.*

## Internal API

- [Cache](./docs/cache.md)
- [Exceptions](./docs/exceptions.md)
- [Environment](./docs/environment.md)
  - [Profile](./docs/environment.md#profile)
  - [Init variables](./docs/environment.md#init-variables)
  - [Environment variables](./docs/environment.md#environment-variables)
- [Init function](./docs/init.md)
- [Context](./docs/context.md)
  - [app](./docs/context.md#aiohttp-application)
  - [env](./docs/context.md#environment)
- [Models](./docs/models.md)


