Merge pull request #55 from nzlosh/pypi

Restructure for pypi packaging.

CHANGELOG.md

@@ -4,12 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-##  [Unreleased]
+##  [3.0.0] 2021-10-20
+
 ### Added
+  - restructured code to use source layout for pypi packaging.
+  - documentation added for readthedocs.
+
 ### Changed
+
 ### Removed
 
+
 ##  [2.1.0] 2021-11-27
+
 ### Added
   - create or use thread when sending message with `in_reply_to`.
   - support of `DIVERT_TO_THREAD` option.
@@ -26,8 +33,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Removed
 
+
 ##  [2.0.2] 2017-11-27
+
 ### Added
+
 ### Changed
   - channelid to be optional to join a room.
 

LICENSE

@@ -652,6 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
+    err-backend-mattermost  Copyright (C) 2022  Errbot backend contributors
     err-backend-mattermost  Copyright (C) 2017-2021  Christian Plümer and contributors
 
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.

MANIFEST.in

@@ -0,0 +1 @@
+include src/err-backend-mattermost/*.plug

pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = [
+    "setuptools>=61.0"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "err-backend-mattermost"
+version = "3.0.0"
+authors = [{ name="Errbot maintainers", email="[email protected]" }]
+keywords = [
+    "errbot",
+    "mattermost",
+]
+description = "Mattermost backend for Errbot"
+readme = "README.md"
+requires-python = ">=3.7"
+
+license = {text = "GPL-3.0"}
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "mattermostdriver>=4.0",
+]
+
+[project.urls]
+"Documentaion" = "https://err-backend-mattermost.readthedocs.io/"
+"Bug Tracker" = "https://github.com/errbotio/err-backend-mattermost/issues"
+
+[tool.setuptools]
+# available as beta since setuptools version 61.0.0
+include-package-data = true

src/err-backend-mattermost/err-backend-mattermost.plug

@@ -0,0 +1,9 @@
+[Core]
+Name = Mattermost
+Module = err-backend-mattermost
+
+[Documentation]
+Description = Mattermost backend for Errbot.
+Author = Christian Plümer and Errbot backend contributors
+Version = 3.0.0
+Website = https://github.com/errbotio/errbot-mattermost-backend

mattermost.py → src/err-backend-mattermost/err-backend-mattermost.py

@@ -25,9 +25,9 @@
     NoAccessTokenProvided,
 )
 
-from src.mattermostPerson import MattermostPerson
-from src.mattermostRoom import MattermostRoom
-from src.mattermostRoomOccupant import MattermostRoomOccupant
+from mattermostlib.mattermostPerson import MattermostPerson
+from mattermostlib.mattermostRoom import MattermostRoom
+from mattermostlib.mattermostRoomOccupant import MattermostRoomOccupant
 
 log = logging.getLogger("errbot.backends.mattermost")
 
@@ -288,7 +288,8 @@ def get_direct_channel(self, userid, other_user_id):
 
     def build_identifier(self, txtrep):
         """
-        Convert a textual representation into a :class:`~MattermostPerson` or :class:`~MattermostRoom`
+        Convert a textual representation into a
+           :class:`~MattermostPerson` or :class:`~MattermostRoom`
 
         Supports strings with the following formats::