Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pepipost/bimi-official
✨ Brand Indicators for Message Identification or BIMI ( 📢 pronounced: Bih-mee) is an emerging email 📧 specification that enables the use of brand-controlled logos within supporting email clients 🔮.
https://github.com/pepipost/bimi-official
authentication brand emails flask flask-application jinja message python3
Last synced: about 2 months ago
JSON representation
✨ Brand Indicators for Message Identification or BIMI ( 📢 pronounced: Bih-mee) is an emerging email 📧 specification that enables the use of brand-controlled logos within supporting email clients 🔮.
- Host: GitHub
- URL: https://github.com/pepipost/bimi-official
- Owner: pepipost
- License: mit
- Created: 2020-08-28T08:36:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T20:54:24.000Z (10 months ago)
- Last Synced: 2024-04-06T06:53:28.376Z (9 months ago)
- Topics: authentication, brand, emails, flask, flask-application, jinja, message, python3
- Language: HTML
- Homepage: https://bimigroup.org/
- Size: 22.7 MB
- Stars: 7
- Watchers: 7
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BIMI-official
Brand Indicators for Message Identification or BIMI (pronounced: Bih-mee) is an emerging email specification that enables the use of brand-controlled logos within supporting email clients
Current Setup is for development purposes.
## Requirements
- python >= 3
- pip dependency manager
- virtualenv - To create a python virtual environment
- java - To parse xml file
## Installation
### Check Python installation
```sh
$ python --version
```
You check [python installation steps](https://www.python.org/downloads/), in case of issues.
### Check pip installation
```sh
$ pip --version
```
[Install pip](https://pip.pypa.io/en/stable/installing/) in case it isn't installed.
### Clone Bimi project from git repository
```sh
$ git clone https://github.com/Hiteshpandey/BIMI-official.git bimi
$ cd bimi
```
### Install Virtualenv
```sh
$ pip install virtualenv
```
### Create a virtual environment
```sh
$ python -m venv env
```
This should create a folder named env inside your bimi setup folder. This might look something like this path C:/bimi/env.
### Activate virtual environment
```sh
# For linux
$ source ./env/bin/activate
# For windows
.\env\Scripts\activate
```
### Install dependencies
```sh
$ pip install -r requirements.txt
```
## Edit configuration file
you can find custom configuration file here -> [custom_config.py](https://github.com/pepipost/BIMI-official/blob/master/custom_config.md)
### Run the application
```sh
$ python .\app.py
```
### Helpful links
[https://bimigroup.org/](https://bimigroup.org/)
[https://pepipost.com/tutorials/bimi/](https://pepipost.com/tutorials/bimi/)