diff --git a/MANIFEST.in b/MANIFEST.in index b58a1db..3c52fde 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -8,4 +8,6 @@ # Copyright (C) 2012 STFC # # Licence: BSD - See LICENCE file for details -recursive-include ndg/ *.crt *.key *.pem README +recursive-include ndg/httpsclient/test *.crt *.key *.pem *.sh README +recursive-include documentation Makefile +recursive-include README \ No newline at end of file diff --git a/README b/README deleted file mode 100644 index c78a2a0..0000000 --- a/README +++ /dev/null @@ -1,41 +0,0 @@ -=============== -ndg_httpsclient -=============== - -Description -=========== -This is a library to enable urllib2 to be used with SSL sockets from pyOpenSSL -instead of the built in ssl library. A script is provided to exercise it: - -ndg_httpclient:: - - Utility to fetch data using HTTP or HTTPS GET from a specified URL. - -Prerequisites -============= -This has been developed and tested for Python 2.6 (compiled with HTTPS support). -pyOpenSSL - - -Installation -============ -Installation can be performed using easy_install, e.g.:: - easy_install ndg_httpsclient-0.1.0-py2.6.egg - -Running ndg_httpclient -====================== -Parameter:: - url The URL of the resource to be fetched - -Options:: - -h, --help Show help message and exit. - -c FILE, --certificate=FILE - Certificate file - defaults to $HOME/credentials.pem - -k FILE, --private-key=FILE - Private key file - defaults to the certificate file - -t DIR, --ca-certificate-dir=DIR - Trusted CA certificate file directory. - -d, --debug Print debug information - this may be useful in - solving problems with HTTP or HTTPS access to a - server. - -f FILE, --fetch=FILE Output file - -n, --no-verify-peer Skip verification of peer certificate.. diff --git a/setup.py b/setup.py index c2ed6f8..cbd947b 100644 --- a/setup.py +++ b/setup.py @@ -5,6 +5,43 @@ use_setuptools() from setuptools import setup, find_packages +_long_description = ''' +This is library provides an equivalent of httplib.HTTPSConnection based on +PyOpenSSL in order to take advantage of the latter's better security +capabilities including peer verification. It also includes an extension to +enable it to be used with urllib2. + +Prerequisites +============= +This has been developed and tested for Python 2.6 and 2.7 with pyOpenSSL. Note +that proxy support is only available from Python 2.6.2 onwards. + +Installation +============ +Installation can be performed using easy_install or pip. + +Running ndg_httpclient +====================== +A simple script for fetching data using HTTP or HTTPS GET from a specified URL. + +Parameter:: + url The URL of the resource to be fetched + +Options:: + -h, --help Show help message and exit. + -c FILE, --certificate=FILE + Certificate file - defaults to $HOME/credentials.pem + -k FILE, --private-key=FILE + Private key file - defaults to the certificate file + -t DIR, --ca-certificate-dir=DIR + Trusted CA certificate file directory. + -d, --debug Print debug information - this may be useful in + solving problems with HTTP or HTTPS access to a + server. + -f FILE, --fetch=FILE Output file + -n, --no-verify-peer Skip verification of peer certificate. +''' + setup( name='ndg_httpsclient', version="0.1.0", @@ -15,6 +52,15 @@ license='BSD - See LICENCE file for details', namespace_packages=['ndg'], packages=find_packages(), + package_dir={'ndg.httpsclient': 'ndg/httpsclient'}, + package_data={ + 'ndg.httpsclient': [ + 'test/README', + 'test/scripts/*.sh', + 'test/pki/localhost.*', + 'test/pki/ca/*.0' + ], + }, install_requires = ['PyOpenSSL'], classifiers = [ 'Development Status :: 3 - Alpha',