# MYNODE SDK
*Software Development Kit for Application Development*
## Installation
The simplest way to install the SDK is from [PyPi](https://pypi.org/manage/project/mynodesdk/releases/) via pip.
`pip3 install mynodesdk`
## Basic Usage
### Create new Application
To create a new application, run the following command. It will prompt for several answers to properly fill out your app template. A folder based on the "App Name ID" will be created in your current folder with the template.
`mynode-sdk create`
It will ask for some things:
- Application Name
- App Name ID (aka short_name)
- Port Numbers
- Requiring Bitcoin, Lightning, Docker, and Electrum
### Update Application Files
After creating the application, you will need to update several things to make the app functional, like the icon, install script, screenshots, etc... More details are available in the [Customizing your Application](#customizing-your-application) section below.
### Build Application
The appliction can be built from within the app folder or one level above.
`mynode-sdk build <app name id>`
### Add Application to Device
Once the application has been built, it can be added to the device via the web interface. In the web interface, navigate Home -> Marketplace -> Add Application. On that page, select the application *tar.gz* file generated during the previous build state. After submitting the form, your app will be available for installation on your device!
## Customizing your Application
After the SDK fills out the template, there are many options available for customizing your app. Some customization steps are required. Replace *appname* with the name id of your app.
### Files to Update
- Update your app icon at *appname*.png
- Update your app info file at *appname*.json
- *author*
- *website*
- *category*
- *short_description*
- *description*
- *latest_version*
- *targz_download_url*
- *app_page_content*
- Update your service file at *appname*.service
- Update your install script at script/install_*appname*.service
- Add your own screenshots under the *screenshots* folder
Details of all the configuration options and scripts can be found in the repo for the [application template](https://github.com/mynodebtc/sdk_app_template).
## Publishing your Application
After testing your application and verifying it works well, you can publish it on the myNode platform and share it with the community!
Submit a Pull Request to the myNode project including your application folder under at `rootfs/standard/usr/share/mynode_apps/<app name id>`.
We reserve the right to reject any apps for any reason. We will review it as part of the pull request. Some rules:
- No altcoins
- Must have applicable category
- Bitcoin
- Lightning
- Networking
- Communication
- Privacy
- Or other similar category
- Must be a quality application
## Manual Local Installation of SDK
To manually install the SDK and to test changes, run this command.
`pip3 install --upgrade --no-deps --ignore-installed --force-reinstall .`
## Publishing New SDK Version
To publish a new SDK version:
- Bump Version in setup.py
- Commit and Push All Changes
- Run `python3.8 -m build`
- Run `twine upload -r pypi dist/mynodesdk-<version>*`
Raw data
{
"_id": null,
"home_page": "https://github.com/mynodebtc/mynode_sdk",
"name": "mynodesdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "mynode,bitcoin,lightning,sdk,applications",
"author": "MYNODE",
"author_email": "admin@mynodebtc.com",
"download_url": "https://files.pythonhosted.org/packages/ca/c5/30b8d539ac87b60bb64572b33b0a4ee8c0add61622b378302768fc3f78ac/mynodesdk-0.0.4.tar.gz",
"platform": null,
"description": "# MYNODE SDK\n*Software Development Kit for Application Development*\n\n## Installation\nThe simplest way to install the SDK is from [PyPi](https://pypi.org/manage/project/mynodesdk/releases/) via pip.\n\n`pip3 install mynodesdk`\n\n## Basic Usage\n\n### Create new Application\n\nTo create a new application, run the following command. It will prompt for several answers to properly fill out your app template. A folder based on the \"App Name ID\" will be created in your current folder with the template.\n\n`mynode-sdk create`\n\nIt will ask for some things:\n- Application Name\n- App Name ID (aka short_name)\n- Port Numbers\n- Requiring Bitcoin, Lightning, Docker, and Electrum\n\n### Update Application Files\n\nAfter creating the application, you will need to update several things to make the app functional, like the icon, install script, screenshots, etc... More details are available in the [Customizing your Application](#customizing-your-application) section below.\n\n### Build Application\n\nThe appliction can be built from within the app folder or one level above.\n\n`mynode-sdk build <app name id>`\n\n### Add Application to Device\n\nOnce the application has been built, it can be added to the device via the web interface. In the web interface, navigate Home -> Marketplace -> Add Application. On that page, select the application *tar.gz* file generated during the previous build state. After submitting the form, your app will be available for installation on your device!\n \n## Customizing your Application\n\nAfter the SDK fills out the template, there are many options available for customizing your app. Some customization steps are required. Replace *appname* with the name id of your app.\n\n### Files to Update\n\n- Update your app icon at *appname*.png\n- Update your app info file at *appname*.json\n - *author*\n - *website*\n - *category*\n - *short_description*\n - *description*\n - *latest_version*\n - *targz_download_url*\n - *app_page_content*\n- Update your service file at *appname*.service\n- Update your install script at script/install_*appname*.service\n- Add your own screenshots under the *screenshots* folder\n\nDetails of all the configuration options and scripts can be found in the repo for the [application template](https://github.com/mynodebtc/sdk_app_template).\n\n## Publishing your Application\n\nAfter testing your application and verifying it works well, you can publish it on the myNode platform and share it with the community!\n\nSubmit a Pull Request to the myNode project including your application folder under at `rootfs/standard/usr/share/mynode_apps/<app name id>`.\n\nWe reserve the right to reject any apps for any reason. We will review it as part of the pull request. Some rules:\n\n- No altcoins\n- Must have applicable category\n - Bitcoin\n - Lightning\n - Networking\n - Communication\n - Privacy\n - Or other similar category\n- Must be a quality application\n\n## Manual Local Installation of SDK\nTo manually install the SDK and to test changes, run this command.\n\n`pip3 install --upgrade --no-deps --ignore-installed --force-reinstall .`\n\n\n## Publishing New SDK Version\nTo publish a new SDK version:\n- Bump Version in setup.py\n- Commit and Push All Changes\n- Run `python3.8 -m build`\n- Run `twine upload -r pypi dist/mynodesdk-<version>*`\n",
"bugtrack_url": null,
"license": "",
"summary": "Tools for creating and managing myNode application package",
"version": "0.0.4",
"split_keywords": [
"mynode",
"bitcoin",
"lightning",
"sdk",
"applications"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c12998d64b6614e3dcc040dd5e98967b",
"sha256": "6dc9112e44828979ab03526b5deebcd7330610bbd32a570b40f020c4973a008c"
},
"downloads": -1,
"filename": "mynodesdk-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c12998d64b6614e3dcc040dd5e98967b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 18086,
"upload_time": "2022-12-30T18:29:40",
"upload_time_iso_8601": "2022-12-30T18:29:40.038784Z",
"url": "https://files.pythonhosted.org/packages/27/42/9b1127838080710e071d611410e21069fec7a3c0788ebbad3334bcf35fa1/mynodesdk-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "5a0506efaaedd664967c8699b9f6f2a5",
"sha256": "effc7baa8cbddd99a03f9ca17f747fb472714b4e231e5533840adb5347de5a41"
},
"downloads": -1,
"filename": "mynodesdk-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5a0506efaaedd664967c8699b9f6f2a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 17651,
"upload_time": "2022-12-30T18:29:42",
"upload_time_iso_8601": "2022-12-30T18:29:42.479310Z",
"url": "https://files.pythonhosted.org/packages/ca/c5/30b8d539ac87b60bb64572b33b0a4ee8c0add61622b378302768fc3f78ac/mynodesdk-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 18:29:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mynodebtc",
"github_project": "mynode_sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mynodesdk"
}
JSON
