github port, ready for pypi

Author: tuxberlin

.gitignore

@@ -1,38 +1,34 @@
-# Byte-compiled / optimized / DLL files
+# General
+tmp/
+bin/
+build/
+dist/
+downloads/
+_trash/
+*~
+*.tmp
+*.bak
+*.swp
+*.log
+
+
+# Python
 __pycache__/
 *.py[cod]
 *$py.class
-
-# C extensions
 *.so
-
-# Distribution / packaging
 .Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
 eggs/
 .eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
+*.egg
 *.egg-info/
+develop-eggs/
 .installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
 
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
@@ -45,45 +41,53 @@ coverage.xml
 *,cover
 .hypothesis/
 
+
 # Translations
 *.mo
 *.pot
 
+
 # Django stuff:
-*.log
 local_settings.py
 
+
 # Flask stuff:
 instance/
 .webassets-cache
 
+
 # Scrapy stuff:
 .scrapy
 
+
 # Sphinx documentation
 docs/_build/
 
+
 # PyBuilder
 target/
 
+
 # IPython Notebook
 .ipynb_checkpoints
 
-# pyenv
-.python-version
-
-# celery beat schedule file
-celerybeat-schedule
-
-# dotenv
-.env
 
 # virtualenv
+.python-version
+.env
+.venv/
+env/
 venv/
 ENV/
 
-# Spyder project settings
-.spyderproject
 
-# Rope project settings
-.ropeproject
+# IDE
+.idea
+.metadata
+*~.nib
+local.properties
+.settings/
+.project
+*.pydevproject
+
+

.travis.yml

@@ -0,0 +1,13 @@
+language:
+  - python
+
+python:
+  - "2.7"
+
+# command to install dependencies
+install:
+  - "pip install -r requirements.txt"
+
+# command to run tests
+script:
+  - pytest tests

LICENSE

@@ -1,3 +1,21 @@
+
+python-keyctl
+
+Copyright (c) 2017 Martin Becker
+
+This work is licensed under the GNU General Public License v3.
+
+This program 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 in version 3 of the License.
+
+This program 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.
+
+=======================================================================
+
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
@@ -631,8 +649,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +670,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:
 
-    {project}  Copyright (C) {year}  {fullname}
+    <program>  Copyright (C) <year>  <name of author>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -672,3 +690,4 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
+

Makefile

@@ -0,0 +1,19 @@
+init:
+	pip install -r requirements.txt
+
+test:
+	pytest tests
+
+build:
+	python setup.py sdist
+	python setup.py bdist_wheel
+
+pypi: clean build
+	twine upload dist/* -r testpypi
+
+clean:
+	find . -type f -name '*~' -delete
+	find . -type f -name '*.o' -delete
+	find . -type f -name '*.pyc' -delete
+	rm -rf build dist .cache *.egg-info tests/__pycache__
+

README.md

@@ -1,2 +1,169 @@
+[//]: # (-*- coding: utf-8 -*-)
+
+
+
 # python-keyctl
+
 Basic management of keys in the Linux kernel keyring in Python. Also comes with a small gui.
+
+
+## Table of contents
+
+[//]: # (AUTO TOC BEGIN)
+
+  * [Description](#description)
+  * [Requirements](#requirements)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    * [Module](#module)
+    * [GUI](#gui)
+  * [Development](#development)
+    * [Warning](#warning)
+  * [Similar projects](#similar-projects)
+  * [License](#license)
+
+[//]: # (AUTO TOC END)
+
+
+## Description
+
+This is a small library to make use of some functions of the kernel keyring in Python. You can read, add and delete keys.
+
+It simply uses the keyctl command (invoking it via subprocess), so this util must be installed.
+
+Available functions:
+
+ * **list** *(list all keys in keyring)*
+ * **describe** *(retrieve key name/description)*
+ * **read/pipe/print** *(retrieve key content)*
+ * **update** *(modify key content)*
+ * **add** *(add key)*
+ * **revoke/unlink** *(delete key)*
+ * **search/request** *(search for a key by name)*
+ * **clear** *(remove all keys from keyring)*
+
+There are many more functions with keys in the kernel keyring (e.g. permissions) that is needed for proper keymanagement. But for my usecase I just needed the given simple functionality. 
+
+
+## Requirements
+
+Python 2.7
+```
+$ sudo apt-get install python2.7
+$ python --version
+Python 2.7.3
+```
+
+pip
+```
+$ sudo apt-get install python-pip
+$ pip --version
+pip 9.0.1 from .... (python 2.7)
+```
+
+The 'keyctl' command
+```
+$ sudo apt-get install keyutils
+$ dpkg -s keyutils | grep Version
+Version: 1.5.2-2
+```
+
+For the GUI you also need:
+
+Qt4
+```
+google it for your distribution
+```
+
+PySide
+```
+$ pip install pyside
+$ pip show pyside | grep Version
+Version: 1.2.4
+```
+
+
+## Installation
+
+```
+$ pip install keyctl
+```
+
+Ready to use.
+
+
+## Usage
+
+### Module
+Get all keys:
+```python
+from keyctl import Key
+keylist = Key.list()
+for mykey in keylist:
+    print mykey.id
+```
+
+Read existing key:
+```python
+from keyctl import Key
+mykey = Key(123)
+print mykey.name
+print mykey.data
+print mykey.data_hex
+```
+
+Find key by name:
+```python
+from keyctl import Key
+mykey = Key.search('test key')
+print mykey.id
+```
+
+Add key:
+```python
+from keyctl import Key
+mykey = Key.add('test key', 'test content')
+print mykey.id
+```
+
+Delete key:
+```python
+from keyctl import Key
+mykey = Key(123)
+mykey.delete()
+```
+
+Update key:
+```python
+from keyctl import Key
+mykey = Key(123)
+mykey.update('new content')
+```
+
+
+### GUI
+To open the GUI, run the installed command.
+```
+$ keyctlgui
+```
+
+
+## Development
+
+### Warning
+
+If you run the integrated tests, your user keyring will be cleared. Don't do this when you have active keys e.g. for encryption.
+
+
+## Similar projects
+
+Similar projects you might want to checkout:
+
+ * https://github.com/sassoftware/python-keyutils (more complete, available in debian repo)
+ * https://github.com/jdukes/pykeyctl (more complete, direct library wrapper)
+
+
+## License
+
+GPL-3.0  
+see [LICENSE](https://raw.githubusercontent.com/tuxberlin/python-keyctl/master/LICENSE) file

keyctl/__init__.py

@@ -0,0 +1,20 @@
+
+# -*- coding: utf-8 -*-
+
+from .keyctlwrapper import KeyctlWrapper
+from .keyctlwrapper import KeyNotExistError, KeyAlreadyExistError, KeyctlOperationError
+
+from .key import Key
+
+
+# -------------------------------------------------------------------
+
+
+import subprocess
+
+# test for keyctl
+try:
+    subprocess.check_output(['which', 'keyctl'])
+except subprocess.CalledProcessError:
+    raise OSError('The commandline util \'keyctl\' must be installed to use this module. ' +
+                  'Install it via \'apt-get install keyutils\'.')