diff --git a/.gitignore b/.gitignore index 4d75ed6..dcb0c7f 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,6 @@ __pycache__ *.pyc venv .venv +build +dist +*.egg-info diff --git a/CHANGELOG b/CHANGELOG index 3d52d7a..58f4980 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,5 @@ +* 0.2.6 + - Upgrade confini * 0.2.5 - Add default env override - Do not create middleware if ipc no set diff --git a/README.md b/README.md index d299d2e..b11fa5b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# CIC PLATFORM SIGNER +# CRYPTO DEV SIGNER This package is written because at the time no good solution seemed to exist for solving the following combined requirements and issues: * A service has custody of its users' private keys. -* The are a large number of private keys involved (tens of thousands minimum). +* The are a large number of private keys involved (hundreds of thousands and up). * Need to sign transactions conforming to EIP-155, with the ability to arbitrarily specify the "chain id". * Do not want to store the keys inside an ethereum node, especially not the one connected to the network. * Want to use the "standard" web3 JSON-RPC interface, so that the component can be easily replaced later. @@ -14,20 +14,12 @@ This package is written because at the time no good solution seemed to exist for ### Scripts -Two scripts are currently available: - -### `crypto-dev-daemon.py` - -An Unix socket IPC server implementing the following web3 json-rpc methods: +When installed with pip/setuptools, this package provides a Unix socket IPC server as `crypto-dev-daemon` implementing the following web3 json-rpc methods: * web3.eth.personal.newAccount * web3.eth.personal.signTransaction * web3.eth.signTransaction -### `web3_middleware.py` - -Demonstrates use of the IPC server as middleware for handling calls to the web3 json-rpc methods provided by the daemon. - ### Classes The classes and packages provided are: @@ -49,9 +41,9 @@ The classes and packages provided are: ## VERSION -This software is in alpha state and very brittle. +This software is in alpha state. -Current version is 0.1.0 +Current version is 0.2.5 ## LICENSE diff --git a/scripts/crypto-dev-daemon b/crypto_dev_signer/runnable/signer.py similarity index 99% rename from scripts/crypto-dev-daemon rename to crypto_dev_signer/runnable/signer.py index 692b47e..f327ab6 100755 --- a/scripts/crypto-dev-daemon +++ b/crypto_dev_signer/runnable/signer.py @@ -212,7 +212,8 @@ def init(): signer = ReferenceSigner(db) -if __name__ == '__main__': +#if __name__ == '__main__': +def main(): init() arg = None try: diff --git a/scripts/crypto-dev-daemon.py b/scripts/crypto-dev-daemon.py deleted file mode 120000 index f54c2e9..0000000 --- a/scripts/crypto-dev-daemon.py +++ /dev/null @@ -1 +0,0 @@ -crypto-dev-daemon \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index c12b278..b802f72 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,3 +1,11 @@ [metadata] +classifiers = + Programming Language :: Python :: 3 + Operating System :: OS Independent + Development Status :: 3 - Alpha + Intended Audience :: Developers + Topic :: Software Development :: Libraries + License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) license = GPLv3 -license_file = LICENSE.txt +license_files = + LICENSE.txt diff --git a/setup.py b/setup.py index 5d64a75..be4778c 100644 --- a/setup.py +++ b/setup.py @@ -1,8 +1,12 @@ from setuptools import setup +f = open('README.md', 'r') +long_description = f.read() +f.close() + setup( name="crypto-dev-signer", - version="0.2.5", + version="0.2.6", description="A signer and keystore daemon and library for cryptocurrency software development", author="Louis Holbrook", author_email="dev@holbrook.no", @@ -11,6 +15,7 @@ setup( 'crypto_dev_signer.eth.web3ext', 'crypto_dev_signer.eth', 'crypto_dev_signer.keystore', + 'crypto_dev_signer.runnable', 'crypto_dev_signer', ], install_requires=[ @@ -21,11 +26,17 @@ setup( 'pysha3', 'rlp', 'json-rpc', - 'confini==0.2.1', + 'confini==0.2.3', ], - scripts = [ - 'scripts/crypto-dev-daemon', - ], - data_files = [('', ['LICENSE.txt'])], + long_description=long_description, + long_description_content_type='text/markdown', + #scripts = [ + # 'scripts/crypto-dev-daemon', + # ], + entry_points = { + 'console_scripts': [ + 'crypto-dev-daemon=crypto_dev_signer.runnable.signer:main', + ], + }, url='https://gitlab.com/nolash/crypto-dev-signer', )