]> jfr.im git - irc/weechat/qweechat.git/commitdiff
Add GitHub actions CI workflow
authorSébastien Helleu <redacted>
Sat, 13 Nov 2021 15:50:49 +0000 (16:50 +0100)
committerSébastien Helleu <redacted>
Sat, 13 Nov 2021 15:54:05 +0000 (16:54 +0100)
.github/workflows/ci.yml [new file with mode: 0644]
README.adoc [deleted file]
README.md [new file with mode: 0644]

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644 (file)
index 0000000..a580ba4
--- /dev/null
@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+
+  build:
+
+    strategy:
+      matrix:
+        python-version:
+          - "3.7"
+          - "3.8"
+          - "3.9"
+
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-20.04
+
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install bandit flake8 pylint
+
+      - name: Lint with flake8
+        run: make flake8
+
+      # - name: Lint with pylint
+      #   run: make pylint
+
+      - name: Lint with bandit
+        run: make bandit
diff --git a/README.adoc b/README.adoc
deleted file mode 100644 (file)
index 074dc3d..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-= QWeeChat
-:author: Sébastien Helleu
-:email: flashcode@flashtux.org
-:lang: en
-
-
-image:https://travis-ci.org/weechat/qweechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/qweechat"]
-
-QWeeChat is a Qt remote GUI for WeeChat written in Python.
-
-Homepage: https://weechat.org/
-
-== Features
-
-* Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
-* Free software, released under GPLv3.
-
-image::https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png[align="center"]
-
-== Install
-
-=== Dependencies
-
-Following packages are *required*:
-
-* WeeChat (version >= 0.3.7) on local or remote machine, with relay plugin
-  enabled and listening on a port with protocol "weechat"
-* Python 3.7+
-* PySide6
-
-=== Install via source distribution
-
-----
-$ pip install .
-----
-
-== WeeChat setup
-
-You have to add a relay port in WeeChat, for example on port 1234:
-
-----
-/set relay.network.password "mypass"
-/relay add weechat 1234
-----
-
-== Connect to WeeChat
-
-In QWeeChat, click on connect and enter fields:
-
-* _server_: the IP address or hostname of your machine with WeeChat running
-* _port_: the relay port (defined in WeeChat)
-* _password_: the relay password (defined in WeeChat)
-
-Options can be changed in file _~/.qweechat/qweechat.conf_.
-
-== Copyright
-
-Copyright (C) 2011-2021 Sébastien Helleu <flashcode@flashtux.org>
-
-This file is part of QWeeChat, a Qt remote GUI for WeeChat.
-
-QWeeChat is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 3 of the License, or
-(at your option) any later version.
-
-QWeeChat is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f5f3013
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# WeeChat Qt remote GUI
+
+[![Build Status](https://github.com/weechat/qweechat/workflows/CI/badge.svg)](https://github.com/weechat/qweechat/actions?query=workflow%3A%22CI%22)
+
+QWeeChat is a Qt remote GUI for WeeChat written in Python.
+
+Homepage: https://weechat.org/
+
+## Features
+
+- Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
+- Free software, released under GPLv3.
+
+![QWeeChat](https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png)
+
+## Install
+
+### Dependencies
+
+QWeeChat requires:
+
+- Python ≥ 3.7
+- [PySide6](https://pypi.org/project/PySide6/)
+- [WeeChat](https://weechat.org) ≥ 0.3.7, on local or remote machine, with relay plugin enabled and listening on a port with protocol "weechat"
+
+### Install via source distribution
+
+```
+$ pip install .
+```
+
+## WeeChat setup
+
+You have to add a relay port in WeeChat, for example on port 1234:
+
+```
+/set relay.network.password "mypass"
+/relay add weechat 1234
+```
+
+## Connect to WeeChat
+
+In QWeeChat, click on connect and enter fields:
+
+- `server`: the IP address or hostname of your machine with WeeChat running
+- `port`: the relay port (defined in WeeChat)
+- `password`: the relay password (defined in WeeChat)
+
+Options can be changed in file `~/.qweechat/qweechat.conf`.
+
+## Copyright
+
+Copyright © 2011-2021 [Sébastien Helleu](https://github.com/flashcode)
+
+This file is part of QWeeChat, a Qt remote GUI for WeeChat.
+
+QWeeChat is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+QWeeChat is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with QWeeChat.  If not, see <https://www.gnu.org/licenses/>.