| Name | ergpy JSON |
| Version |
0.1.9.1
JSON |
| download |
| home_page | https://github.com/mgpai22/ergpy |
| Summary | Python-jvm wrapper for interacting with the Ergo Blockchain |
| upload_time | 2023-12-04 23:13:46 |
| maintainer | |
| docs_url | None |
| author | MGpai |
| requires_python | |
| license | MIT |
| keywords |
appkit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ergpy
A python-jvm wrapper for interacting with the Ergo blockchain.
# Usage
- Requires Java 8 or higher to be installed on system
```
pip install ergpy
```
- There are helper methods created to do simple transactions
- Please checkout the `examples.py` (on github) to see how to use them.
- `Simple Send` is available
- Allows sending ERG to one address or multiple addresses in ONE transactions
- `Get wallet addresses` is available
- This gives derivations of wallet addresses given the mnemonic
- If specified `2`, a list of two addresses will be printed in the console
- `Get Box Info` is available
- Given the index and address, the selected box will be printed
- `Send Token` is available
- Allows sending token(s) to one or multiple addresses
- The token id paramter must be given as a 2D array
- Remember that tokens/nfts are seen as the same when transacting with them
- `Create NFT` is available
- Allows creating NFTs
- One mint is one transaction
- There are helper methods as well to get the sha-256 hash required while minting
- `SHA256 caster`
- Put the hash as a string and this will be converted into bytes
- `String Hasher`
- Input a string and this will be converted into a hash (only for testing purposes)
- `File Hasher`
- Input the file name and the hash will be generateed
- `Create Token` is available
- Allows a token to be minted
- Custom
- A bit more customization is available using methods from `appkit.py`
- To truly have custom transactions `appkit.py` must be edited
## Github usage
```
git clone https://github.com/mgpai22/ergpy && cd ergpy
```
```
pip3 install -r requirements.txt
```
```
python -m stubgenj --convert-strings --classpath "./ergpy/ergo.jar" org.ergoplatform java
```
- If using an ide such as pycharm , make sure the root folder is ergpy
- This allows code completion via stubgenj to work properly
- This method is recommended for developer as it allows for direction customizations in `appkit.py`
# Roadmap
- This is the begining of python support for Ergo! Contributions are essential for this to continue.
- Ergoscript support.
- Better documentation and packaging (first time creating a package).
- Would love some help with this!
# Credits
- [MrStahlfelge](https://github.com/ergoplatform/ergo-appkit/wiki/Using-Appkit-from-Python)
- Showcased jpype usage with appkit
- [Ergopad](https://github.com/ergo-pad/ergopad-api/blob/nft-locked-vesting/app/ergo/appkit.py)
- Borrowed/Modified some of their code
Raw data
{
"_id": null,
"home_page": "https://github.com/mgpai22/ergpy",
"name": "ergpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "appkit",
"author": "MGpai",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/50/68/6c3e35d294c799ab7501b151be20e8d25af832965dd29c75f975065028cf/ergpy-0.1.9.1.tar.gz",
"platform": null,
"description": "\r\n# ergpy \r\n\r\nA python-jvm wrapper for interacting with the Ergo blockchain.\r\n\r\n# Usage\r\n\r\n- Requires Java 8 or higher to be installed on system\r\n\r\n```\r\npip install ergpy\r\n```\r\n- There are helper methods created to do simple transactions\r\n - Please checkout the `examples.py` (on github) to see how to use them.\r\n - `Simple Send` is available \r\n - Allows sending ERG to one address or multiple addresses in ONE transactions\r\n - `Get wallet addresses` is available\r\n - This gives derivations of wallet addresses given the mnemonic\r\n - If specified `2`, a list of two addresses will be printed in the console \r\n - `Get Box Info` is available\r\n - Given the index and address, the selected box will be printed\r\n - `Send Token` is available\r\n - Allows sending token(s) to one or multiple addresses\r\n - The token id paramter must be given as a 2D array\r\n - Remember that tokens/nfts are seen as the same when transacting with them\r\n - `Create NFT` is available\r\n - Allows creating NFTs \r\n - One mint is one transaction \r\n - There are helper methods as well to get the sha-256 hash required while minting\r\n - `SHA256 caster`\r\n - Put the hash as a string and this will be converted into bytes\r\n - `String Hasher`\r\n - Input a string and this will be converted into a hash (only for testing purposes)\r\n - `File Hasher`\r\n - Input the file name and the hash will be generateed\r\n - `Create Token` is available\r\n - Allows a token to be minted\r\n - Custom\r\n - A bit more customization is available using methods from `appkit.py`\r\n - To truly have custom transactions `appkit.py` must be edited\r\n\r\n## Github usage\r\n\r\n```\r\ngit clone https://github.com/mgpai22/ergpy && cd ergpy\r\n```\r\n```\r\npip3 install -r requirements.txt\r\n```\r\n```\r\npython -m stubgenj --convert-strings --classpath \"./ergpy/ergo.jar\" org.ergoplatform java\r\n```\r\n- If using an ide such as pycharm , make sure the root folder is ergpy\r\n - This allows code completion via stubgenj to work properly\r\n- This method is recommended for developer as it allows for direction customizations in `appkit.py`\r\n\r\n# Roadmap\r\n- This is the begining of python support for Ergo! Contributions are essential for this to continue.\r\n- Ergoscript support.\r\n- Better documentation and packaging (first time creating a package).\r\n - Would love some help with this!\r\n\r\n# Credits \r\n\r\n- [MrStahlfelge](https://github.com/ergoplatform/ergo-appkit/wiki/Using-Appkit-from-Python)\r\n - Showcased jpype usage with appkit\r\n- [Ergopad](https://github.com/ergo-pad/ergopad-api/blob/nft-locked-vesting/app/ergo/appkit.py)\r\n - Borrowed/Modified some of their code\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python-jvm wrapper for interacting with the Ergo Blockchain",
"version": "0.1.9.1",
"project_urls": {
"Homepage": "https://github.com/mgpai22/ergpy"
},
"split_keywords": [
"appkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02610dec86bd96bad2ed697bb3dad5ec8fbbaed0242e6afd511fe916076526be",
"md5": "18acdc8b56a237b3ace64ca9b036daa1",
"sha256": "54f354d3256747685231c6ae00341cfa479dbbf254e60379301358338267bfc7"
},
"downloads": -1,
"filename": "ergpy-0.1.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18acdc8b56a237b3ace64ca9b036daa1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 50194365,
"upload_time": "2023-12-04T23:13:40",
"upload_time_iso_8601": "2023-12-04T23:13:40.797602Z",
"url": "https://files.pythonhosted.org/packages/02/61/0dec86bd96bad2ed697bb3dad5ec8fbbaed0242e6afd511fe916076526be/ergpy-0.1.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50686c3e35d294c799ab7501b151be20e8d25af832965dd29c75f975065028cf",
"md5": "3cecc7156b05aaffd3dbbb7228dd1ec1",
"sha256": "41bad6e44ccaf4823a62c72752696c4bfca18f3188fe999c0c12f72bed7b6445"
},
"downloads": -1,
"filename": "ergpy-0.1.9.1.tar.gz",
"has_sig": false,
"md5_digest": "3cecc7156b05aaffd3dbbb7228dd1ec1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 50181430,
"upload_time": "2023-12-04T23:13:46",
"upload_time_iso_8601": "2023-12-04T23:13:46.313622Z",
"url": "https://files.pythonhosted.org/packages/50/68/6c3e35d294c799ab7501b151be20e8d25af832965dd29c75f975065028cf/ergpy-0.1.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 23:13:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mgpai22",
"github_project": "ergpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ergpy"
}
