{ "info": { "author": "Toons", "author_email": "moustikitos@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3" ], "description": "Copyright 2017 **Toons**, `MIT licence`_\n\nInstall\n=======\n\nUbuntu / OSX\n^^^^^^^^^^^^\n\n>From development version\n\n``sudo -H pip install git+https://github.com/Moustikitos/oxycoin.git``\n\nIf you work with ``python3``\n\n``sudo -H pip3 install git+https://github.com/Moustikitos/oxycoin.git``\n\nWindows \n^^^^^^^\n\n>From development version\n\n``pip install git+https://github.com/Moustikitos/oxycoin.git``\n\nUsing ``pyoxy``\n===============\n\n*Compatibility with lisk and shift is not fully supported at the moment, if you go there you're on your own !*\n\nUse Oxycoin API\n^^^^^^^^^^^^^^^\n\n``api`` module allows developpers to send requests to the blockchain. For\nsecurity reason only run ``POST`` and ``PUT`` entrypoints from blockchain node.\n\n>>> from pyoxy import api\n>>> api.use(\"toxy\") # work on testnet\n\nAll entrypoints can be reach using this syntax :\n\n``api.[METHOD].[entrypoint with \"/\" replaced by \".\"](param=value, ...[returnKey=name])``\n\n>>> # http equivalent [PEER ADDRESS]/api/delegates/get?username=toons\n>>> api.GET.delegates.get(username=\"toons\")\n{'delegate': {'address': '12773656026018032534X', 'vote': '50649323252343', 'pub\nlicKey': '926f731a0fbc04d845fe10f6d4917c47317704af55151c08e07be6616220ddaf', 'us\nername': 'toons', 'rank': 28, 'rate': 28, 'approval': 0.5, 'producedblocks': 154\n, 'missedblocks': 0, 'productivity': 100}, 'success': True}\n\nIt returns a python dictionary transposed from server json response. You can\nprovide a ``returnKey`` option value to get the field you want from server response\n\n>>> api.GET.delegates.get(username=\"toons\", returnKey=\"delegate\")\n{'address': '12773656026018032534X', 'vote': '50649323252343', 'publicKey': '926\nf731a0fbc04d845fe10f6d4917c47317704af55151c08e07be6616220ddaf', 'username': 'too\nns', 'rank': 28, 'rate': 28, 'approval': 0.5, 'producedblocks': 154, 'missedbloc\nks': 0, 'productivity': 100}\n\nSend Oxycoin\n^^^^^^^^^^^^\n\n``pyoxy`` bakes transaction localy using ``pynacl`` crypto library so no secret is\nsent trough the network. only ``type-0`` transaction can be broadcasted for now.\nAmount is given in SATOSHI.\n\n>>> from pyoxy import api, util\n>>> api.use(\"toxy\") \n>>> util.sendTransaction(amount=100000000, recipientId=\"15981732227677853647X\", secret=\"your secret\")\n{'success': True}\n\nCommand line interface\n^^^^^^^^^^^^^^^^^^^^^^\n\nYou can use ``pyoxy`` package without writing a line of code trough command\nline interface. There are two ways to launch the CLI.\n\n**from command line**\n\n``python -m pyoxy-cli``\n\n**from python code**\n\n>>> from pyoxy import cli\n>>> cli.start()\nWelcome to pyoxy-cli [Python 3.5.1 / pyoxy 0.1b]\nAvailable commands: network, account, delegate\ncold@.../>\n\n**How to send Oxycoins ?**\n\n>>> from pyoxy import cli\n>>> cli.start()\nWelcome to pyoxy-cli [Python 3.5.1 / pyoxy 0.1b]\nAvailable commands: network, account, delegate\ncold@.../> network use\nNetwork(s) found:\n 1 - lisk\n 2 - oxy\n 3 - shift\n 4 - toxy\nChoose an item: [1-4]> 4\nhot@toxy/network> account link \"your secret with spaces between quotes\"\nhot@toxy/account[15600...1854X]> send 1.1235 12427608128403844156X\n{'success': True}\n\n**How to run a pool ?**\n\n>>> from pyoxy import cli\n>>> cli.start()\nWelcome to pyoxy-cli [Python 3.5.1 / pyoxy 0.1b]\nAvailable commands: network, account, delegate\ncold@.../> network use\nNetwork(s) found:\n 1 - lisk\n 2 - oxy\n 3 - shift\n 4 - toxy\nChoose an item: [1-4]> 4\nhot@toxy/network> delegate link \"your secret with spaces between quotes\"\nhot@toxy/account[15600...1854X]> share --options=values\n\n+ ```` value can be:\n * relative value ie 10% of account balance\n * absolute value using decimal numbers 45.6\n * fiat ($60, \u00c2\u00a341, \u00e2\u201a\u00ac62 or \u00c2\u00a5125) value converted using ``coinmarketcap`` API\n+ ``options`` can be :\n * ``-b`` or ``--blacklist`` a coma-separated-address-list or a full path to newline-separated-address file\n * ``-d`` or ``--delay`` the number of day you want to analyse voters behaviour\n * ``-l`` or ``--lowest`` the treshold payout to trigger payment (unpaid payout are saved)\n * ``-h`` or ``--highest`` the ceiling payout\n\nGraphical user interface (python 3.x)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nRun the pyoxy payout user interface: ``python -m pyoxy-ui``\n\n.. image:: https://github.com/Moustikitos/oxycoin/raw/master/pyoxy-ui.png\n\nAuthors\n=======\n\nToons \n\nSupport this project\n====================\n\n+ Toons Bitcoin address: ``1qjHtN5SuzvcA8RZSxNPuf79iyLaVjxfc``\n+ Toons Oxycoin address: ``12427608128403844156X``\n+ Vote for **toons** delegate on oxycoin blockchain\n\nVersion\n=======\n\n**0.3**\n\n+ Added ``lisk`` and ``shift`` network\n\n**0.2**\n\n+ ``ui`` pkg released\n\n**0.1**\n\n+ ``api`` mod released\n+ ``crypto`` mod released\n+ ``util`` mod released\n+ ``cli`` pkg released\n\n.. _MIT licence: http://htmlpreview.github.com/?https://github.com/Moustikitos/oxycoin/blob/master/pyoxy.html\n.. role:: red\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/ArkEcosystem/pyoxy.git", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ArkEcosystem/pyoxy", "keywords": "api,Oxycoin", "license": "Copyright 2017 Toons, MIT licence", "maintainer": "", "maintainer_email": "", "name": "pyoxy", "package_url": "https://pypi.org/project/pyoxy/", "platform": "", "project_url": "https://pypi.org/project/pyoxy/", "project_urls": { "Download": "https://github.com/ArkEcosystem/pyoxy.git", "Homepage": "https://github.com/ArkEcosystem/pyoxy" }, "release_url": "https://pypi.org/project/pyoxy/0.3/", "requires_dist": [ "docopt", "pynacl", "pytz", "requests", "yawTtk" ], "requires_python": "", "summary": ".", "version": "0.3" }, "last_serial": 3250378, "releases": { "0.3": [ { "comment_text": "", "digests": { "md5": "dea6d470a5ec8b18cd24b95a648c726f", "sha256": "cc2b712f904f72e5daf5fe59e37e9fc2ce9b11d61b1bba4e725983672552eba3" }, "downloads": -1, "filename": "pyoxy-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "dea6d470a5ec8b18cd24b95a648c726f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 25425, "upload_time": "2017-10-14T17:26:05", "url": "https://files.pythonhosted.org/packages/ef/63/6d8116a784e27ae6ccd33505ef9f2c9b2a16e479d27ccd6a3ed1083bff6d/pyoxy-0.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "dea6d470a5ec8b18cd24b95a648c726f", "sha256": "cc2b712f904f72e5daf5fe59e37e9fc2ce9b11d61b1bba4e725983672552eba3" }, "downloads": -1, "filename": "pyoxy-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "dea6d470a5ec8b18cd24b95a648c726f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 25425, "upload_time": "2017-10-14T17:26:05", "url": "https://files.pythonhosted.org/packages/ef/63/6d8116a784e27ae6ccd33505ef9f2c9b2a16e479d27ccd6a3ed1083bff6d/pyoxy-0.3-py3-none-any.whl" } ] }