Merge pull request #1 from qtc-de/develop

Make kutil a pip package

Author: qtc-de

.github/workflows/develop.yml

@@ -0,0 +1,45 @@
+name: develop Python CI
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Cache pip
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=11 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.github/workflows/master.yml

@@ -0,0 +1,45 @@
+name: master Python CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Cache pip
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=11 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.github/workflows/pypi.yml

@@ -0,0 +1,28 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist
+        twine upload dist/*

README.md

@@ -6,6 +6,9 @@
 It supports different operations like merging, splitting and modifying ticket caches.
 A detailed list of all supported operations can be found in the [operations section](#supported-operations).
 
+![](https://github.com/qtc-de/kutil/workflows/master%20Python%20CI/badge.svg?branch=master)
+![](https://github.com/qtc-de/kutil/workflows/develop%20Python%20CI/badge.svg?branch=develop)
+
 
 ### Table of Contents
 
@@ -38,25 +41,32 @@ A detailed list of all supported operations can be found in the [operations sect
 
 ----
 
-*kutil* is just an executable python script, not a library. Just install the required
-dependencies and copy the script to a folder within your ``$PATH``.
-On *Kali Linux*, all dependencies should be preinstalled and *kutil* should work out of the box.
+*kutil* can be build and installed as a *pip* package. The following
+command installs *kutil* for your current user profile:
+
+```console
+$ pip3 install kutil
+```
+
+You can also build *kutil* from source and install it directly by using
+the following commands:
 
 ```console
 $ git clone https://github.com/qtc-de/kutil
-$ pip3 install -r kutil/requirements.txt
-$ ln -s $(realpath kutil/kutil.py) ~/.local/bin/kutil
+$ cd kutil
+$ pip3 install -r requirements.txt
+$ python3 setup.py sdist
+$ pip3 install dist/*
 ```
 
-*kutil* supports autocompletion for *bash* and the corresponding completion script can be found
-inside the [bash_completion.d](./bash_completion.d) folder. The script assumes that the
-[bash-completion](https://github.com/scop/bash-completion) package is installed and that
-my [completion-helpers](https://github.com/qtc-de/completion-helpers) functions are available.
-If you setup both projects, you can just copy the completion script inside your local
-``~/.bash_completion.d`` folder:
+Additionally, *kutil* ships a [bash-completion](./kutil/resources/bash_completion.d/kutil) script.
+The completion script is installed automatically, but relies on the [completion-helpers](https://github.com/qtc-de/completion-helpers)
+package. If *completion-helpers* is already installed, autocompletion for *kutil* should
+work after installing the pip package. Otherwise, you may need to copy the completion
+script manually:
 
 ```console
-$ ln -s $(realpath kutil/bash_completion.d/kutil) ~/bash_completion.d/kutil
+$ cp kutil/resources/bash_completion.d/kutil ~/.bash_completion.d
 ```