Metadata-Version: 2.1
Name: mistela-flask
Version: 0.14.7
Summary: A multi-event planner flask application. It allows for RSVP options, authentication, and guest management
Home-page: https://github.com/carsopre/mistela-flask
License: MIT
Author: Carles S. Soriano Perez
Author-email: sorianoperez.carles@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Flask (>=2.2.2,<3.0.0)
Requires-Dist: Flask-Login (>=0.6.2,<0.7.0)
Requires-Dist: Flask-Mail (>=0.9.1,<0.10.0)
Requires-Dist: commitizen (>=2.35.0,<3.0.0)
Requires-Dist: flask-sqlalchemy (>=3.0.2,<4.0.0)
Requires-Dist: gunicorn (>=20.1.0,<21.0.0)
Requires-Dist: pyOpenSSL (>=22.1.0,<23.0.0)
Project-URL: Repository, https://github.com/carsopre/mistela-flask
Description-Content-Type: text/markdown

![GitHub release (latest by date)](https://img.shields.io/github/v/release/carsopre/mistela-flask)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/carsopre/mistela-flask)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# mistela-flask
A multi-event planner elaborated with Flask.

Initial steps done following this [Digital Ocean guide](https://www.digitalocean.com/community/tutorials/how-to-add-authentication-to-your-app-with-flask-login#step-7-setting-up-the-authorization-function)

This version of `Flask` aims to provide a simpile solution to manage an event such as a wedding with different 'sub-events'. The tool also provides a custom-defined admin page as `Flask` does not really provide one itself (and I did not like `Flask-admin` as all users seemed to have admin rights).

Either way, this was a nice user-case for me to get hands-on with Flask.

## Why the name Mistela?
Mistela is 'sort of a wine' quite common in my region (València, Spain) for celebrations or simply after a family dinner. It made sense that if this flask 'flavour' is about events (celebrations) management, it should have an appropiate name, therefore, mistela-flask :).

## Downloading the package.
* Directly from the source:
```cli
pip install git+https://github.com/Carsopre/mistela-flask.git
```
* Or from pypi:
```cli
pip install mistela-flask
```

## Installing the repository.
To develop on the repository you should be using `Poetry`. Once installed, simply run the install command`poetry install` and all development and production dependencies will be added to your virtual environment.

## Usage
Mistela-flask can be used as a package and easily deployed as any regular flask app.
```python
from mistelaflask import create_app
import secrets
import os
os.environ["SECRET_KEY"] = secrets.token_hex(16) # Required environment variable.
os.environ["DATABASE_URI"] = "sqlite:///db.sqlite"
os.environ["MISTELA_TITLE"] = "My big event"
os.environ["STATIC_FOLDER"] = "path//to//my//static//folder"
os.environ["MAIL_USERNAME"] = "joe.doe@email.com"
os.environ["MAIL_PASSWORD"] = "1234"

app = create_app() 
app.run()
```
> By default, mistelaflask will run on a `SQLite` database.

A more 'real' example can be found in the root of the repository as `wsgi.py`.



