# myb-nicehash-api
An API client for the NiceHash API
## Installation
The package is availble via PyPi and can be installed with the following command:
```
pip3 install myb-nicehash-api
```
To install it from the repo, clone the repo and cd into the directory:
```
git clone https://github.com/mine-your-business/myb-nicehash-api.git
cd myb-nicehash-api
```
You can install this library with `pip`:
```
pip3 install .
```
## Testing
To run tests, simply run the following command:
```
pytest --verbose
```
## Releases
Releases should follow a [Semantic Versioning](https://semver.org/) scheme.
When changes have been made that warrant a new release that should be published, modify the `__version__` in [`setup.py`](setup.py)
After the change is merged to the `main` branch, go to [releases](https://github.com/mine-your-business/myb-nicehash-api/releases) and `Draft a new release`. The `Tag version` should follow the pattern `v1.0.0` and should `Target` the `main` branch.
The `Release title` should not include the `v` from the tag and should have a reasonably detailed description of the new release's changes.
Once the release has been published, the [`.github/workflows/python-publish.yml`](.github/workflows/python-publish.yml) GitHub Actions Workflow should trigger and automatically upload the new version to [PyPi](https://pypi.org/) using GitHub secrets credentials stored with the [Mine Your Business GitHub Organization](https://github.com/mine-your-business).
Raw data
{
"_id": null,
"home_page": "https://github.com/mine-your-business/myb-nicehash-api",
"name": "myb-nicehash-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Mine Your Business",
"author_email": "mine.your.business.crypto@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a5/42/da1f09d74aac5e6cbb7195b122d7b8787504f1da2b9d8ec2debc1c0b7e3e/myb-nicehash-api-2.3.0.tar.gz",
"platform": null,
"description": "# myb-nicehash-api\n An API client for the NiceHash API\n\n## Installation\n\nThe package is availble via PyPi and can be installed with the following command:\n```\npip3 install myb-nicehash-api\n```\n\nTo install it from the repo, clone the repo and cd into the directory:\n\n```\ngit clone https://github.com/mine-your-business/myb-nicehash-api.git\ncd myb-nicehash-api\n```\n\nYou can install this library with `pip`:\n\n```\npip3 install .\n```\n\n## Testing\n\nTo run tests, simply run the following command:\n\n```\npytest --verbose\n```\n\n## Releases\n\nReleases should follow a [Semantic Versioning](https://semver.org/) scheme. \n\nWhen changes have been made that warrant a new release that should be published, modify the `__version__` in [`setup.py`](setup.py) \n\nAfter the change is merged to the `main` branch, go to [releases](https://github.com/mine-your-business/myb-nicehash-api/releases) and `Draft a new release`. The `Tag version` should follow the pattern `v1.0.0` and should `Target` the `main` branch. \n\nThe `Release title` should not include the `v` from the tag and should have a reasonably detailed description of the new release's changes. \n\nOnce the release has been published, the [`.github/workflows/python-publish.yml`](.github/workflows/python-publish.yml) GitHub Actions Workflow should trigger and automatically upload the new version to [PyPi](https://pypi.org/) using GitHub secrets credentials stored with the [Mine Your Business GitHub Organization](https://github.com/mine-your-business).\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "Python library for communicating with the NiceHash API",
"version": "2.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4b496725e2e0fcd659f089ae93fd4702",
"sha256": "2e8ea5107e338c91307db90bf0bbde7f548c35ddc86b8d186cc36eae71a33792"
},
"downloads": -1,
"filename": "myb_nicehash_api-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b496725e2e0fcd659f089ae93fd4702",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18023,
"upload_time": "2022-12-13T20:57:54",
"upload_time_iso_8601": "2022-12-13T20:57:54.461935Z",
"url": "https://files.pythonhosted.org/packages/48/82/60ec9487eecd385707e5aaf0ca6446b1b007374717e8ad971314f6852e8f/myb_nicehash_api-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "af4b8350602d73f075b77ba8e16ec389",
"sha256": "d25617a4587421aa389c0bc2080ab2e6dd87e8886bf2f160b2c2a89d2657823a"
},
"downloads": -1,
"filename": "myb-nicehash-api-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "af4b8350602d73f075b77ba8e16ec389",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17948,
"upload_time": "2022-12-13T20:57:55",
"upload_time_iso_8601": "2022-12-13T20:57:55.957248Z",
"url": "https://files.pythonhosted.org/packages/a5/42/da1f09d74aac5e6cbb7195b122d7b8787504f1da2b9d8ec2debc1c0b7e3e/myb-nicehash-api-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-13 20:57:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mine-your-business",
"github_project": "myb-nicehash-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "myb-nicehash-api"
}
JSON
