Merge pull request #1 from errbotio/master

Update to the latest version

Author: zichul

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'type: bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Provide steps to reproduce the behavior or include sample plugin code.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+- Errbot version:
+- OS version:
+- Python version: 
+- Using a virtual environment: yes/no
+- Using Docker: yes/no
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'type: feature'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Is feature related to**
+
+- [ ] Backend support
+- [ ] Plugins (storage, flows)
+- [ ] Functionality
+- [ ] Other
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Support - Running bot or plugins
+about: Requesting help with running errbot
+title: ''
+labels: 'type: support/question'
+assignees: ''
+
+---
+
+**Need help with**
+
+- [ ] Running the bot
+- [ ] Writing plugin
+- [ ] Other
+
+**Issue description**
+Please describe the issue. The more information you can provide, the better.
+
+**Steps to reproduce**
+Provide steps to reproduce the behavior or include sample plugin code.
+
+**Environment (please complete the following information):**
+- Errbot version:
+- OS version:
+- Python version:
+- Using a virtual environment: yes/no
+- Using Docker: yes/no
+
+
+**Additional info**
+If you have any more information, please specify it here.

.github/ISSUE_TEMPLATE/support---running-bot-or-plugins.md

@@ -0,0 +1,28 @@
+name: build docker image
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    if: github.repository_owner == 'errbotio'
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+
+    - name: build and push docker image
+      uses: mr-smithers-excellent/docker-build-push@v5
+      with:
+        image: errbotio/errbot
+        tags: latest
+        registry: docker.io
+        dockerfile: Dockerfile
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}

.github/workflows/docker-build.yml

@@ -9,19 +9,22 @@ on:
   pull_request:
     branches: [ master ]
 
+permissions:
+  contents: read
+
 jobs:
   build:
 
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9, "3.10"]
 
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -38,21 +41,26 @@ jobs:
         tox -e py
 
     - name: Check Distribution
-      if: ${{ matrix.python-version == '3.8' }}
+      if: ${{ matrix.python-version == '3.9' }}
       run: |
         tox -e dist-check
 
     - name: Codestyle
-      if: ${{ matrix.python-version == '3.8' }}
+      if: ${{ matrix.python-version == '3.9' }}
       run: |
         tox -e codestyle
 
     - name: Lint - sort
-      if: ${{ matrix.python-version == '3.8' }}
+      if: ${{ matrix.python-version == '3.9' }}
       run: |
         tox -e sort
 
     - name: Security
-      if: ${{ matrix.python-version == '3.8' }}
+      if: ${{ matrix.python-version == '3.9' }}
       run: |
         tox -e security
+
+    - name: Docs
+      if: ${{ matrix.python-version == '3.9' }}
+      run: |
+        tox -e docs

.github/workflows/python-package.yml

@@ -1,4 +1,68 @@
-v6.1.8 (unreleased)
+v9.9.9 (unreleased)
+-------------------
+
+breaking:
+
+- backend/slack: remove slack and slack_rtm built-in backends (#1581)
+
+features:
+
+- core/plugins: detect plugins using entrypoints (#1590)
+
+fixes:
+
+- docs: add unreleased section (#1576)
+- docs: update broken URL for Markdown Extra (#1572)
+- chore: bump actions/setup-python version (#1575)
+- backend/telegram: fix missing imports (#1574)
+- chore: ci improvements (#1577, #1583)
+- chore: add docs build to ci (#1582)
+- backend/xmpp: fix forward type references (#1578)
+- chore: remove campfire references (#1584)
+- chore/setup: fix exception when installing on python <3.7 (#1585)
+- docs: typos (#1589)
+
+
+v6.1.9 (2022-06-11)
+-------------------
+
+features:
+
+- core: set default backend to Text (#1522)
+- core: option to divert all commands to private or thread (#1528)
+- core: add type hints to core and backend functions (#1542)
+- docs: add ACL and numerous backends to official documentation (#1552)
+- core: add Python 3.10 to automated tests (#1539)
+- core: add room acl attribute (#1530)
+- chore: refactor Dockerfile errbot install and python version bump (#1571)
+
+fixes:
+
+- core: success handling for update_repos (#1520)
+- core/plugins: cascade dependency plugins (#1519)
+- core/plugins: reload all repo plugins when updating a repo (#1521)
+- plugin_manager: correct syntax error (#1524)
+- backend/text: add stub send_stream_request method (#1527)
+- backend/hipchat: remove HipChat backend (#1525)
+- backend/test: shutdown sequence to address test failure (#1535)
+- core: various minor logging improvements (#1536)
+- chore: various minor formatting improvements (#1541)
+- docs: update spark plugin reference (#1546)
+- fix: python 2 version references in docs and init template (#1543)
+- backends: deprecate built-in Slack and SlackRTM (#1526)
+- chore: remove python 3.6 checks and test environment (#1540)
+- chore: add/update issue templates (#1554)
+- chore: pin all package dependencies (#1553, #1559)
+- core/webserver: use errbot loglevel for consistent logging. (#1556)
+- fix/core: prevent infinite loop when only BOT_PREFIX is passed (#1557)
+- chore: bump actions/setup-python from 2 to 3.1.0 (#1563)
+- chore: Set permissions for GitHub actions (#1565)
+- fix: removed deprecated argument reconnection_interval for irc v20.0 (#1568)
+- docs: Add Gentoo packages (#1567)
+- chore: bump actions/setup-python from 3.1.0 to 3.1.2 (#1564)
+- fix: circular dependencies error when there are none (#1505)
+
+v6.1.8 (2021-06-21)
 -------------------
 
 features:

CHANGES.rst

@@ -1,21 +1,30 @@
-FROM python:3.8-slim as BUILD
+FROM python:3.9-slim as build
 WORKDIR /wheel
 COPY . .
-RUN pip3 wheel --wheel-dir=/wheel \
-    errbot errbot[irc] errbot[slack] errbot[XMPP] errbot[telegram]
+RUN apt update && apt install -y build-essential git
+RUN cd /tmp && \
+    git clone https://github.com/errbotio/err-backend-slackv3 slackv3
+RUN pip3 wheel --wheel-dir=/wheel . \
+    -r /tmp/slackv3/requirements.txt wheel \
+    errbot errbot[irc] errbot[XMPP] errbot[telegram] && \
+    cp /tmp/slackv3/requirements.txt /wheel/slackv3-requirements.txt
 
-FROM python:3.8-slim
-COPY --from=BUILD /wheel /wheel
+FROM python:3.9-slim as base
+COPY --from=build /wheel /wheel
 RUN apt update && \
     apt install -y git && \
     cd /wheel && \
-    pip3 -vv install --no-cache-dir --no-index --find-links /wheel \
-    errbot errbot[irc] errbot[slack] errbot[XMPP] errbot[telegram] && \
+    pip3 -vv install --no-cache-dir --no-index --find-links /wheel . \
+    -r /wheel/slackv3-requirements.txt \
+    errbot errbot[irc] errbot[XMPP] errbot[telegram] && \
     rm -rf /wheel /var/lib/apt/lists/*
-
 RUN useradd -m errbot
-USER errbot
+
+FROM base
 EXPOSE 3141 3142
 VOLUME /home/errbot
 WORKDIR /home/errbot
+USER errbot
+RUN errbot --init
+RUN git clone https://github.com/errbotio/err-backend-slackv3 backend-plugins/slackv3
 ENTRYPOINT [ "/usr/local/bin/errbot" ]

Dockerfile

@@ -43,17 +43,15 @@ Chat servers support
 **Built-in**
 
 - IRC support
-- `Hipchat support <http://www.hipchat.com/>`_
-- `Slack support <https://slack.com/>`_
 - `Telegram support <https://www.telegram.org/>`_
 - `XMPP support <http://xmpp.org>`_
 
 **With add-ons**
 
-- `CampFire <https://campfirenow.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-campfire>`__)
-- `Cisco Spark <https://www.ciscospark.com/>`_ (See `instructions <https://github.com/marksull/err-backend-cisco-spark>`__)
-- `Discord <https://www.discordapp.com/>`_ (See `instructions <https://github.com/gbin/err-backend-discord>`__)
+- `Slack support <https://slack.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-slackv3>`__)
+- `Discord <https://www.discordapp.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-discord>`__)
 - `Gitter support <https://gitter.im/>`_ (See `instructions <https://github.com/errbotio/err-backend-gitter>`__)
+- `Webex <https://www.webex.com/>`_ (See `instructions <https://github.com/marksull/err-backend-cisco-webex-teams>`__)
 - `Mattermost <https://about.mattermost.com/>`_ (See `instructions <https://github.com/Vaelor/errbot-mattermost-backend>`__)
 - `RocketChat <https://rocket.chat/>`_ (See `instructions <https://github.com/cardoso/errbot-rocketchat>`__)
 - `Skype <https://www.skype.com/>`_ (See `instructions <https://github.com/errbotio/errbot-backend-skype>`__)
@@ -81,14 +79,14 @@ Developer features
 - Presetup storage for every plugin i.e. ``self['foo'] = 'bar'`` persists the value.
 - Conversation flows to track conversation states from users.
 - Webhook callbacks support
-- supports `markdown extras <https://pythonhosted.org/Markdown/extensions/extra.html>`_ formatting with tables, embedded images, links etc.
+- supports `markdown extras <https://markdown-extra.readthedocs.io/>`_ formatting with tables, embedded images, links etc.
 - configuration helper to allow your plugin to be configured by chat
 - Text development/debug consoles
 - Self-documenting: your docstrings become help automatically
 - subcommands and various arg parsing options are available (re, command line type)
 - polling support: your can setup a plugin to periodically do something
 - end to end test backend
-- card rendering under Slack and Hipchat.
+- card rendering under Slack
 
 Community and support
 ---------------------
@@ -132,12 +130,12 @@ It will show you a prompt `>>>` so you can talk to your bot directly! Try `!help
 Adding support for a chat system
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-For the built-ins, just use one of those options `slack, hipchat, telegram, IRC, XMPP` with pip, you can still do it
+For the built-ins, just use one of those options `telegram, IRC, XMPP` with pip, you can still do it
 after the initial installation to add the missing support for example ::
 
-   $ pip install "errbot[slack]"
+   $ pip install "errbot[irc]"
 
-For the external ones (Skype, Gitter, Discord etc ...), please follow their respective github pages for instructions.
+For the external ones (Slack, Discord, Gitter, Skype, etc ...), please follow their respective github pages for instructions.
 
 Configuration
 ~~~~~~~~~~~~~

README.rst

@@ -32,7 +32,7 @@ Publishing to Read the Docs
 Read the Docs should rebuild the site automatically when new commits are pushed.
 When new project releases are made, it may be necessary to add the new version
 and remove older versions (to prevent clutter in the version drop-down).
-This can be done at https://readthedocs.org/dashboard/errbot/versions/.
+This can be done at https://readthedocs.org/projects/errbot/versions/.
 
 
 .. _Sphinx: http://sphinx-doc.org/