Skip to content

pyjokes/pyjokes-stand

Repository files navigation

Python jokes web support

This application represents support of random one line jokes for programmers (https://pyjok.es) shipped with python and flask micro-web framework.

Please follow https://pyjokes-stand.herokuapp.com web app to see how it looks like.

Build Status Coverage Status

Tools

  • pyjokes
  • python 3.7
  • html/css/js
  • pytest
  • shell
  • travis CI
  • heroku

Table of contents

Usage

Run script from the root directory of the project:

python joker.py

Demo Screenshot

Development notes

Run static code analysis

In general static code analysis consists of following tools: black, flake8, pylint, mypy, pydocstyle and unittests (using pytest) accordingly. To be able to start static code analysis locally please run following script from the root directory of the project:

./run-code-assessment.sh install-dependencies

Anyway it will be run via CI automatically after every change was made to the repo via Travis CI.

Heroku deployment

Please follow instructions from - https://python-responder.org/en/latest/deployment.html

heroku login
  • Create an application
heroku create pyjokes-stand
  • Commit and push repo into a heroku
git add . && git commit -m "Add pyjokes heroku app" && git push heroku master
  • Check heroku logs
heroku logs --tail

Meta

Heroku automation master – Volodymyr Yahello vyahello@gmail.com

Distributed under the BSD license. See LICENSE for more information.

You can reach out me at (for heroku automations inquiries):

Contributing

  1. clone the repository
  2. configure Git for the first time after cloning with your name and email
  3. pip install -r requirements.txt to install all project dependencies
  4. pip install -r requirements-dev.txt to install all project development dependencies