aboutsummaryrefslogtreecommitdiffstats
path: root/lang/python/pyme/__init__.py
diff options
context:
space:
mode:
authorDaniel Kahn Gillmor <[email protected]>2016-10-28 20:45:49 +0000
committerJustus Winter <[email protected]>2016-10-31 14:42:27 +0000
commit2fac017618a76882605125b05ff1f7393fe99860 (patch)
treeb7eddc17682b6aa91b8c3c723a2fc02f28ac0a6c /lang/python/pyme/__init__.py
parentcore: New API functions gpgme_set_sender, gpgme_get_sender. (diff)
downloadgpgme-2fac017618a76882605125b05ff1f7393fe99860.tar.gz
gpgme-2fac017618a76882605125b05ff1f7393fe99860.zip
python: Rename Python module from PyME to gpg.
This follows weeks of discussion on the gnupg-devel mailing list. Hopefully it will make it easier for people using Python to use GnuPG in the future. Signed-off-by: Daniel Kahn Gillmor <[email protected]>
Diffstat (limited to 'lang/python/pyme/__init__.py')
-rw-r--r--lang/python/pyme/__init__.py125
1 files changed, 0 insertions, 125 deletions
diff --git a/lang/python/pyme/__init__.py b/lang/python/pyme/__init__.py
deleted file mode 100644
index 12c96c28..00000000
--- a/lang/python/pyme/__init__.py
+++ /dev/null
@@ -1,125 +0,0 @@
-# Copyright (C) 2016 g10 Code GmbH
-# Copyright (C) 2004 Igor Belyi <[email protected]>
-# Copyright (C) 2002 John Goerzen <[email protected]>
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library 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
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-"""Pyme: GPGME Interface for Python
-
-Welcome to PyME, the GPGME Interface for Python. "Pyme", when prounced,
-rhymes with "Pine".
-
-The latest release of this package may be obtained from
-https://www.gnupg.org
-
-Previous releases of this package for Python 2 can be obtained from
-http://pyme.sourceforge.net
-
-FEATURES
---------
-
- * Feature-rich, full implementation of the GPGME library. Supports
- all GPGME features. Callback functions may be written in pure
- Python. Exceptions raised in callbacks are properly propagated.
-
- * Ability to sign, encrypt, decrypt, and verify data.
-
- * Ability to list keys, export and import keys, and manage the keyring.
-
- * Fully object-oriented with convenient classes and modules.
-
-QUICK EXAMPLE
--------------
-
- >>> import pyme
- >>> with pyme.Context() as c:
- >>> with pyme.Context() as c:
- ... cipher, _, _ = c.encrypt("Hello world :)".encode(),
- ... passphrase="abc")
- ... c.decrypt(cipher, passphrase="abc")
- ...
- (b'Hello world :)',
- <pyme.results.DecryptResult object at 0x7f5ab8121080>,
- <pyme.results.VerifyResult object at 0x7f5ab81219b0>)
-
-GENERAL OVERVIEW
-----------------
-
-For those of you familiar with GPGME, you will be right at home here.
-
-Pyme is, for the most part, a direct interface to the C GPGME
-library. However, it is re-packaged in a more Pythonic way --
-object-oriented with classes and modules. Take a look at the classes
-defined here -- they correspond directly to certain object types in GPGME
-for C. For instance, the following C code:
-
-gpgme_ctx_t context;
-gpgme_new(&context);
-...
-gpgme_op_encrypt(context, recp, 1, plain, cipher);
-
-Translates into the following Python code:
-
-context = core.Context()
-...
-context.op_encrypt(recp, 1, plain, cipher)
-
-The Python module automatically does error-checking and raises Python
-exception pyme.errors.GPGMEError when GPGME signals an error. getcode()
-and getsource() of this exception return code and source of the error.
-
-IMPORTANT NOTE
---------------
-This documentation only covers a small subset of available GPGME functions and
-methods. Please consult the documentation for the C library
-for comprehensive coverage.
-
-This library uses Python's reflection to automatically detect the methods
-that are available for each class, and as such, most of those methods
-do not appear explicitly anywhere. You can use dir() python built-in command
-on an object to see what methods and fields it has but their meaning can
-be found only in GPGME documentation.
-
-FOR MORE INFORMATION
---------------------
-PYME3 homepage: https://www.gnupg.org/
-GPGME documentation: https://www.gnupg.org/documentation/manuals/gpgme/
-
-"""
-
-from __future__ import absolute_import, print_function, unicode_literals
-del absolute_import, print_function, unicode_literals
-
-from . import core
-from . import errors
-from . import constants
-from . import util
-from . import callbacks
-from . import version
-from .core import Context
-from .core import Data
-
-# Interface hygiene.
-
-# Drop the low-level gpgme that creeps in for some reason.
-gpgme = None
-del gpgme
-
-# This is a white-list of symbols. Any other will alert pyflakes.
-_ = [Context, Data, core, errors, constants, util, callbacks, version]
-del _
-
-__all__ = ["Context", "Data",
- "core", "errors", "constants", "util", "callbacks", "version"]