增强现实AR>> ebedke>> 返回
项目作者： ijanos

项目描述 ：
crawl pages to check what is for lunch today
高级语言： Python
项目地址: git://github.com/ijanos/ebedke.git
创建时间： 2017-08-09T20:08:13Z
项目社区：https://github.com/ijanos/ebedke
开源协议：Other
下载


Ebédke 🍽

There are two hard things in computer science, cache invalidation and deciding
where to eat.

Ebédke is a Python web crawler that collects the daily menu from
restaurants’ webpages. The collected menus are cached in redis and can be viewed in
an HTML page or in JSON format with the included Flask app.

Architecture

The updater.py is a standalone script that will run a loop and update expired
pages every 30 seconds and then pushes them to redis. The web.py script is a
simple Flask app that lists daily menus read from redis.

Development

The python packages dependencies can be found in pyproject.toml and can be
managed with Poetry.

Use this command to install the dependencies:

  1. poetry install

A Facebook app
token
is required to read posts from facebook pages.
A Google Cloud Vision API key is required for OCR capabilities.

API keys are stored in environment variables.

  1. export EBEDKE_REDIS_HOST=localhost
  2. export EBEDKE_REDIS_PORT=6379
  3. export FACEBOOK_ACCESS_TOKEN=token
  4. export GOOGLE_API_KEY=apikey

Redis is required, please start redis-server before running ebekde, running
without redis is not supported.

Running individual plugins is possible as standalone modules like this:

  1. poetry run python -m ebedke.plugins.pqs

An additional arugment can be used to go back or forward in time:

  1. poetry run python -m ebedke.plugins.pqs -3

The Flask dev server is enough for testing purposes but not recommended for
production:

  1. poetry run python -m ebedke.web

Subdomains can be easily be tested with the xip.io service.

  1. http://test.127.0.0.1.xip.io:5000/

Tests

Some tests are provided in the tests directory, they can be run with pytest.

poetry run pytest

Type hints are also provided in many places, the project can be type-checked
with mypy checker.

poetry run mypy -p ebedke

I also recommend using the pylint python linter with my configuration file

poetry run pylint --rcfile=pylintrc ebedke

Plugins

Plugins live in ebedke/plugins as single python files. To add a new plugin
just drop a new file there following this plugin skeleton

  1. from datetime import timedelta
  2. from ebedke.pluginmanager import EbedkePlugin
  4. def download_menu(today):
  5.     return ["menu line 1", "menu line 2"]
  7. plugin = EbedkePlugin(
  8.     enabled=True,
  9.     groups=["corvin"], # which subdomains it should show up
  10.     name='My Restaurant',
  11.     id='mrr', # a short id string
  12.     url="http://myrestarunt.myrestaruant",
  13.     downloader=download_menu,
  14.     ttl=timedelta(hours=6), # how often should ebedke update the menu
  15.     cards=['szep'] # accepted cafeteria cards
  16.     coord=(47.4, 19.1) # GPS coordinates of the place
  17. )

Pre-commit hook

There is a pre-commit git hook included in the resources directory. I
recommend using it to run all the tests and linters before commiting or if
thats a bit annoying then using it as a pre-push hook.

  1. ln -s ../../resources/git-hooks/pre-commit .git/hooks/

Deployment

Using a production webserver with a wsgi server like gunicorn or uwsgi is
recommended. An example nginx config is included in the resources directory.

Example gunicron command line

  1. gunicorn --bind=0.0.0.0:80 -w 4 ebedke.web:app

An ansible playbook is available in the resources directroy that deploys a
ebedke on Fedora linux.

License

The source code in the repository is licensed under either of

at your option.