https://github.com/tiagocordeiro/pyassinamail

Gera assinaturas de email automagicamente a partir de uma planilha no google spreadsheets
https://github.com/tiagocordeiro/pyassinamail

hacktoberfest

Last synced: about 2 months ago
JSON representation

Gera assinaturas de email automagicamente a partir de uma planilha no google spreadsheets

• Host: GitHub
• URL: https://github.com/tiagocordeiro/pyassinamail
• Owner: tiagocordeiro
• License: mit
• Created: 2017-10-16T15:42:12.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-11T08:42:39.000Z (4 months ago)
• Last Synced: 2024-10-30T09:43:24.058Z (3 months ago)
• Topics: hacktoberfest
• Language: Python
• Homepage:
• Size: 120 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PyAssinaMail

Gera assinaturas de email automagicamente a partir de uma planilha no google spreadsheets

[![Updates](https://pyup.io/repos/github/tiagocordeiro/pyassinamail/shield.svg)](https://pyup.io/repos/github/tiagocordeiro/pyassinamail/)

[![Python 3](https://pyup.io/repos/github/tiagocordeiro/pyassinamail/python-3-shield.svg)](https://pyup.io/repos/github/tiagocordeiro/pyassinamail/)

[![Build Status](https://travis-ci.org/tiagocordeiro/pyassinamail.svg?branch=master)](https://travis-ci.org/tiagocordeiro/pyassinamail)

[![codecov](https://codecov.io/gh/tiagocordeiro/pyassinamail/branch/master/graph/badge.svg)](https://codecov.io/gh/tiagocordeiro/pyassinamail)

[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/tiagocordeiro/pyassinamail/blob/master/LICENSE)

[![Veja no youtube](https://img.youtube.com/vi/WYjf94H-Lm0/0.jpg)](https://www.youtube.com/watch?v=WYjf94H-Lm0)

#### Como usar

Antes de mais nada você precisa ter uma planilha online como a do exemplo:

> [Planilha Google de exemplo](https://docs.google.com/spreadsheets/d/1vW0NDxmZcQ-Gna9LY6vnsjDm6hVc55QSOt9VGtTAnds/)

> O compartilhamento de links deve estar `Ativado`

![Imagem do compartilhamento de links do Google Planilhas](docs/images/google_planilha_share.png)

> Agora você precisa do ID da planilha, você pode pegar na url.

![Imagem da url com o ID da planilha selecionado](docs/images/google_planilha_id.png)

#### Como rodar o projeto

* Clone esse repositório.

* Crie um virtualenv com Python 3.

* Ative o virtualenv.

* Instale as dependências.

* Rode o script

```shell

git clone https://github.com/tiagocordeiro/pyassinamail.git

cd pyassinamail

python3 -m venv venv

source venv/bin/activate

pip install --upgrade pip

pip install -r requirements.txt

python contrib/env_gen.py

python app.py

```

Os arquivos `.html` serão gerados na pasta `assinaturas/`

> Exemplo de uso com template

```shell

python app.py --template chemical.html

```

> Importando no seu projeto

```shell

>>> from app import gera_assinatura_html

>>> assinaturas = gera_assinatura_html

>>> assinaturas.callback()

{'retorno': {'assinaturas': [('Foo', 'Bar', '[email protected]'), ('Bar', 'Foo', '[email protected]')]}}

```

#### Testes, contribuição e dependências de desenvolvimento

Para instalar as dependências de desenvolvimento

```shell

pip install -r requirements-dev.txt

```

Para rodar os testes

```shell

pytest --cov='.' tests.py -v

python -m doctest README.md -v

```

Para gerar o relatório de cobertura de testes

```shell

coverage html

```

Verificando o `Code style`

```shell

pycodestyle .

flake8 .

```

#### Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

### Thanx

- [[ ~ Dependencies scanned by PyUp.io ~ ]](https://pyup.io/)

#### License

[MIT](https://github.com/tiagocordeiro/pyassinamail/blob/master/LICENSE)