Estou iniciando este projeto para entender melhor como o flask funciona, e aplicar o conhecimento que obtive estudando as suas ferramentas.
- gunicorn - Ferramenta de WSGI
- python-decouple - Ferramenta de gestão de variáveis de ambiente
- Flask - Framework web
- Flask-WTF - Wrapper para criação de formulários
- Flask-Babel - Wrapper para manipulação de fuso e idioma
- Flask-SQLAlchemy - Ferramenta de ORM
- Flask-Migrate - Wrapper para migração de banco de dados
- Werkzeug - Ferramenta responsável por gerar e validar Hashs
- Flask-Login - Extensão para gerenciamento de autenticação
- Email-Validator - Complemento para o flask-wtf
- Flask-Mail - Extensão para trabalhar com emails
- pyjwt - Biblioteca do python que gera tokens (Json Web Tokens)
- Flask-Moment - Wrapper da biblioteca moment.js para tratamento de datas
- Flask-Pagedown - Extensão de formulário para formatar markdown
- Flask-Misaka - Extensão para renderizar markdown
-
Poetry:
Eu usei poetry para gerenciar este projeto.
Se você quiser usar poetry também, basta seguir a documentação oficial deles para instalar em sua plataforma > Poetry Docs.
Com o Poetry instalado, basta entrar no diretório clonado deste projeto e rodar:
poetry install
E para ativar o ambiente virtual:
poetry shell
-
Pip:
Se não quiser usar o poetry, pode instalar o requirements.txt em seu ambiente virtual:
pip install -r requirements.txt
python wsgi.pypode acessa-lo através do endereço: http://localhost:5000
ou
gunicorn wsgi:apppode acessa-lo através do endereço: http://localhost:8000
-
OBS: Este projeto está atualmente configurado para usar um banco de dados mysql. Caso queira testar com um banco de dados mais simples como o sqlite, recomendo remover a pasta migrations antes de continuar com as etapas abaixo.
flask db init flask db migrate flask db upgrade
Para ter acesso aos recursos, basta usar:
flask shellA configuração de contexto foi predefinida no wsgi.py o que dá acesso direto as instãncias de "app", "db", "User", "Post" e "Reply".
>>> app
<Flask 'app'>
>>> db
<SQLAlchemy engine=sqlite:///>
>>> User
<class 'app.models.User'>
>>> Post
<class 'app.models.Post'>
>>> Reply
<class 'app.models.Reply'>Para rodar, basta executar o comando a baixo que o python gera automaticamente um servidor local.
python -m smtpd -n -c DebuggingServer localhost:8025- As configurações para usar este serviço já estão predefinidas.
- caso queira usar algum serviço de email dedicado, basta trocar os valores nas variáveis de ambiente no seu arquivo .env.
- Primeiro passo; precisa configurar o contexto do app como foi feito no
__init__.py - Segundo passo; precisa inserir o
{{ moment.include_moment() }}nos templates que precisar, para que o moments seja carregado. - Terceiro passo; basta usar o jinja2 para invocar as datas e formatar através do
{{ moment(data).fromNow() }} - Por último; pode acrescentar um
{{ moment.locale(auto_detect=True) }}para detectar automaticamente o idioma do navegador.
Formatos de datas suportados:
moment('2021-06-28T21:45:23Z').format('L') # "06/28/2021"
moment('2021-06-28T21:45:23Z').format('LL') # "June 28, 2021"
moment('2021-06-28T21:45:23Z').format('LLL') # "June 28, 2021 2:45 PM"
moment('2021-06-28T21:45:23Z').format('LLLL') # "Monday, June 28, 2021 2:45 PM"
moment('2021-06-28T21:45:23Z').format('dddd') # "Monday"
moment('2021-06-28T21:45:23Z').fromNow() # "7 hours ago"
moment('2021-06-28T21:45:23Z').calendar() # "Today at 2:45 PM"Para começar, o docker precisa estar instalado.
-
Como este projeto é extremamente simples, montei um esquema de imagem equivalente. tudo que precisa para funcionar é executar os comandos a seguir:
1 - Para criar a imagem a partir dos arquivos fornecidos, basta rodar o comando:
docker build -t blog-simples:latest .2 - Após criar a imagem, use o comando a baixo para rodar o projeto:
- Após rodar o projeto, pode acessa-lo através do endereço: http://localhost:8000
docker run -d --rm --name blog-simples -p 8000:8000 -v $PWD:/home/blog-simples/ blog-simples:latest3 - Para ver os logs do servidor, basta usar o comando a baixo ou trocar a flag "-d" por "-it" do comando acima:
docker logs blog-simples
4 - Para finalizar a execução, basta usar o comando:
docker stop blog-simples
Se quiser instalar algum pacote diferente, basta acrescentar ao requirements.txt e rodar o primeiro comando novamente.
- Se quiser testar os serviços de email com o docker, basta executar este comando em outro terminal enquanto o projeto estiver rodando:
docker exec -it blog-simples python -m smtpd -n -c DebuggingServer localhost:8025
Para começar, o docker precisa estar instalado.
-
Para rodar apenas o banco de dados com docker:
1 - Iniciar o container do mysql com as configurações abaixo:
docker run \ --rm -d --name mysql \ -e MYSQL_RANDOM_ROOT_PASSWORD=yes \ -e MYSQL_DATABASE=blogsimples \ -e MYSQL_USER=blogsimples \ -e MYSQL_PASSWORD=blogsimples \ -p 3306:3306 \ mysql/mysql-server:latest
2 - Configurar o DATABASE_URL no
.envdo projeto:DATABASE_URL = mysql+pymysql://blogsimples:blogsimples@localhost:3306/blogsimples
3 - Fazer as migrações para criar as tabelas no banco de dados:
flask db migrate flask db upgrade
4 - Finalizar o container após o uso:
docker stop mysql
-
Para rodar o projeto e o banco de dados com docker:
1 - Iniciar o container do banco de dados com as configurações abaixo.
docker run \ --rm -d --name mysql \ -e MYSQL_RANDOM_ROOT_PASSWORD=yes \ -e MYSQL_DATABASE=blogsimples \ -e MYSQL_USER=blogsimples \ -e MYSQL_PASSWORD=blogsimples \ mysql/mysql-server:latest
2 - Configurar o DATABASE_URL no
.envdo projeto:DATABASE_URL = mysql+pymysql://blogsimples:blogsimples@dbserver/blogsimples
3 - Fazer as migrações para criar as tabelas no banco de dados:
flask db migrate flask db upgrade
4 - Iniciar o container do projeto com as configurações abaixo:
- Após rodar o projeto, pode acessa-lo através do endereço: http://localhost:8000
docker run \ --rm -d -p 8000:8000 --name blog-simples \ -v $PWD:/home/blog-simples/ \ --link mysql:dbserver \ blog-simples:latest5 - Para finalizar a execução, basta usar o comando:
docker stop blog-simples mysql