Merge pull request #1 from HackSoc/master

updating cause I forked this ages ago

Author: FromAnkyra

.dockerignore

@@ -0,0 +1,14 @@
+# Exclude everything by default
+*
+
+# Whitelist specific files
+!src/**/*
+!tests/**/*
+!setup.py
+!requirements.txt
+!pytest.ini
+!csbot.*.cfg
+
+# Exclude Python temp files
+**/__pycache__
+**/*.pyc

.gitignore

@@ -27,7 +27,7 @@ cabal-dev
 *.egg
 *.egg-info
 dist
-build
+build/
 eggs
 parts
 bin
@@ -58,3 +58,9 @@ htmlcov
 
 # Linters
 .ropeproject/
+
+# Project-specific files
+csbot.cfg
+.env
+deploy.env
+mongodb-data/

.travis.yml

@@ -1,18 +1,17 @@
 sudo: false
 dist: xenial
 language: python
-python:
-  - 3.6
-  - 3.7
-
 install:
-  - pip install -r requirements.txt
+  - pip install tox
 
-script:
-  - pytest -v --cov
+matrix:
+  include:
+    - python: '3.6'
+      env: TOXENV=py36-coveralls
+    - python: '3.7'
+      env: TOXENV=py37-coveralls
 
-after_success:
-  - coveralls
+script: tox
 
 cache:
   directories:
@@ -24,12 +23,3 @@ notifications:
     - irc.freenode.org#cs-york-dev
     skip_join: true
     use_notice: true
-
-deploy:
-  provider: heroku
-  api_key:
-    secure: jHzS/L/cN/6gCNJrmVCVDb0V4+Zc1b/PnTYcVfoaAw7/USIb2ZQbU6uwPCpGZ8EL/dQlgOCwJY1UYzowm5d6xvXw+9+iHOIBAAgPe0VEmJ2GMPd1/n8cl5CiJ+LF3NXyBml/F4BL/2wm+kZUxINeZfJaim2OAd9g8PfgpHUey5A=
-  app: csyorkbot
-  on:
-    repo: HackSoc/csbot
-    python: '3.6'

Dockerfile

@@ -1,26 +1,16 @@
-FROM ubuntu:18.04
+FROM python:3.7
 
-# From python:3.5 docker image, set locale
-ENV LANG C.UTF-8
+ARG UID=9000
+ARG GID=9000
 
-VOLUME /app
-WORKDIR /app
-
-# Update base OS
-RUN apt-get -y update && apt-get -y upgrade
-# Install Python 3(.4)
-RUN apt-get -y install python3 python3-dev python-virtualenv
-# Install dependencies for Python libs
-RUN apt-get -y install libxml2-dev libxslt1-dev zlib1g-dev
+RUN groupadd -g $GID app \
+ && useradd -u $UID -g $GID --no-create-home app
 
-# Copy needed files to build docker image
-ADD requirements.txt docker-entrypoint.sh ./
-
-# Create virtualenv
-RUN virtualenv -p python3 /venv
-# Populate virtualenv
-RUN ./docker-entrypoint.sh pip install --upgrade pip
-RUN ./docker-entrypoint.sh pip install -r requirements.txt
+COPY --chown=app:app . /app
+WORKDIR /app
+RUN pip install -r requirements.txt
 
-ENTRYPOINT ["./docker-entrypoint.sh"]
-CMD ["./run_csbot.py", "csbot.cfg"]
+ARG SOURCE_COMMIT
+ENV SOURCE_COMMIT $SOURCE_COMMIT
+USER app:app
+CMD ["csbot", "csbot.cfg"]

README.rst

@@ -14,7 +14,7 @@ and running [1]_::
     $ python3 -m venv venv3
     $ source venv3/bin/activate
     $ pip install -r requirements.txt
-    $ ./run_csbot.py --help
+    $ csbot --help
 
 Look at ``csbot.deploy.cfg`` for an example of a bot configuration.
 
@@ -29,6 +29,22 @@ Docker containers (a MongoDB instance and the bot)::
 
     $ docker-compose up
 
+This will use the `published image`_. To build locally::
+
+    $ docker build -t alanbriolat/csbot:latest .
+
+Environment variables to expose to the bot, e.g. for sensitive configuration
+values, should be defined in ``deploy.env``.  Environment variables used in
+``docker-compose.yml`` should be defined in ``.env``:
+
+==========================  ==================  ===========
+Variable                    Default             Description
+==========================  ==================  ===========
+``CSBOT_CONFIG_LOCAL``      ``./csbot.cfg``     Path to config file in host filesystem to mount at ``/app/csbot.cfg``
+``CSBOT_CONFIG``            ``csbot.cfg``       Path to config file in container, relative to ``/app``
+``CSBOT_WATCHTOWER``        ``false``           Set to ``true`` to use Watchtower_ to auto-update when published container is updated
+==========================  ==================  ===========
+
 Backup MongoDB once services are running::
 
     $ docker-compose exec -T mongodb mongodump --archive --gzip --quiet > foo.mongodump.gz
@@ -73,3 +89,5 @@ We're also using Travis-CI for continuous integration and continuous deployment.
 .. _asyncio: https://docs.python.org/3/library/asyncio.html
 .. _lxml: http://lxml.de/
 .. _Docker Compose: https://docs.docker.com/compose/
+.. _published image: https://hub.docker.com/r/alanbriolat/csbot
+.. _Watchtower: https://containrrr.github.io/watchtower/

csbot.deploy.cfg

@@ -1,8 +1,10 @@
 [@bot]
+ircv3 = true
 nickname = Mathison
 auth_method = sasl_plain
 channels = #cs-york #cs-york-dev #compsoc-uk #hacksoc #hacksoc-bottest
 plugins = logger linkinfo hoogle imgur csyork usertrack auth topic helix calc mongodb termdates whois xkcd youtube last webserver webhook github
+client_ping = 60
 
 [linkinfo]
 scan_limit = 2
@@ -47,7 +49,7 @@ end =
 
 [webserver]
 host = 0.0.0.0
-port = 80
+port = 8000
 
 [github]
 # Re-usable format strings