Add setup.py

This commit is contained in:
Pedro Ferreira 2017-07-30 22:37:34 +02:00
parent e6b91af497
commit f25a9868a2
4 changed files with 102 additions and 18 deletions

0
CHANGES.rst Normal file
View File

View File

@ -1,18 +0,0 @@
** WORK IN PROGRESS **
## pyssb - Secure Scuttlebutt in Python
Please, don't use this for anything that is not experimental. This is a first attempt at implementing the main functionality needed to run an SSB client/server.
Things that are currently implemented:
* Basic Message feed logic
* Secret Handshake
* packet-stream protocol
Usage:
```sh
$ pip install -r requirements.txt
```
Check the `test_*.py` files for basic examples.

19
README.rst Normal file
View File

@ -0,0 +1,19 @@
**WORK IN PROGRESS**
pyssb - Secure Scuttlebutt in Python
====================================
Please, don't use this for anything that is not experimental. This is a first attempt at implementing the main
functionality needed to run an SSB client/server.
Things that are currently implemented:
* Basic Message feed logic
* Secret Handshake
* packet-stream protocol
Usage::
$ pip install -r requirements.txt
Check the ``test_*.py`` files for basic examples.

83
setup.py Normal file
View File

@ -0,0 +1,83 @@
# Copyright (c) 2017 PySecretHandshake contributors (see AUTHORS for more details)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""A module that implements Secret Handshake as specified in "Designing a Secret Handshake: Authenticated
Key Exchange as a Capability System" (Dominic Tarr, 2015)."""
from setuptools import find_packages, setup
readme = open('README.rst').read()
history = open('CHANGES.rst').read()
tests_require = [
'check-manifest>=0.25',
'coverage>=4.0',
'isort>=4.2.2',
'pep257>=0.7.0',
'pytest-cov>=1.8.0',
'pytest>=3.1.1',
'pytest-asyncio==0.6.0',
'asynctest==0.10.0'
]
extras_require = {
'docs': [
'Sphinx>=1.6.2',
],
'tests': tests_require,
}
extras_require['all'] = sum((lst for lst in extras_require.values()), [])
install_requires = [
'pynacl==1.1.2'
]
setup_requires = [
'pytest-runner'
]
packages = find_packages()
setup(
name='ssb',
version='0.0.1',
description=__doc__,
long_description=(readme + '\n\n' + history),
license='MIT',
author='PyScuttleButt Contributors',
author_email='pedro@dete.st',
url='https://github.com/pferreir/PyScuttlebutt',
packages=packages,
include_package_data=True,
extras_require=extras_require,
install_requires=install_requires,
setup_requires=setup_requires,
tests_require=tests_require,
zip_safe=False,
classifiers=[
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Topic :: Software Development :: Libraries :: Python Modules',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6'
],
)