| Name | vshieldpy JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | Python library for interacting with the vShield API. |
| upload_time | 2024-03-13 19:11:58 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | |
| keywords |
servers
virtaul server
vps
vshield
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# vshieldpy
A library designed to ease the use of the vShield API when using python.
Almost all functionality of the API is implemented, and with proper exceptions.
[](https://github.com/astral-sh/ruff)
[](https://vshieldpy.readthedocs.io/en/latest)
[](https://github.com/airblast-dev/vshieldpy/actions/workflows/python-package.yml)
[](https://opensource.org/licenses/MIT)
> **_NOTE:_** This is an unofficial library for the vShield API. There-for vShield is not responsible for any issues regarding this library.
[](https://vshield.com)
## Supported Products:
All products do have support, however virtual servers (VPS, VDS and VDS-PRO)
have priority in testing and ease of use as that is what I can test for.
## Documentation:
### Online Version:
You can read the online version of the documentation [here](https://vshieldpy.readthedocs.io/en/latest/). You can also download the offline version from the documentation page if preferred.
### Building it yourself:
After cloning the repository, you must install the library with the "docs" tag.
```bash
python -m pip install ".[docs]"
```
Once it is done, all of the dependencies required to build the documentation will be installed.
You can now build the documentation with a single command.
```bash
python -m sphinx docs/ docs/_build
```
The built documentation will be stored in the `docs/_build` directory of the project.
Now you can simply open the `index.html` file in your browser of choice, and get started.
## Examples:
### REPL:
Example for creating a client and sending a request to check the accounts current balance.
```python-repl
>>> # For use via the repl, "python -m asyncio" is more practical since its easier to use with async functions.
>>> from vshieldpy import Client
>>> client = Client("YOUR_TOKEN")
>>> await client.fetch_balance()
'0.00'
```
> **_NOTE:_** For an implementation example in an application such as a discord bot, feel free to check out the [examples](examples/README.md).
## Contribution:
The library does cover all API paths, however, there are a few small things missing.
- Setting a wallpaper for a server. (This is only doable if you have reseller access)
- Tasks are not stored in the instance of a server, said tasks are only returned by `/server/getInfo/<server_id>`.
- The ease of use of the library might be lacking for various use cases such as hosting a reseller website. I am open to ways this can be improved.
- Implementing testing for exceptions. Most important ones are already implemented, however a few (mainly parameter exceptions) are not tested.
For non-breaking and/or small changes feel free to create a PR. If not create an issue so a solution can be discussed.
You can install all the dependencies needed for development using the "dev" tag as shown below.
```bash
pip install ".[dev]"
```
This will install the dev dependencies needed for testing, linting, and formatting.
For formatting and linting [ruff](https://github.com/astral-sh/ruff) is used.
You can run `python -m ruff check`, and `python -m ruff format` in the project to check if there is any issues.
For testing [pytest](https://github.com/pytest-dev/pytest) is used.
You can simply run `python -m pytest` in the project directory to start the tests.
Raw data
{
"_id": null,
"home_page": "",
"name": "vshieldpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "servers,virtaul server,vps,vshield,web",
"author": "",
"author_email": "Tayfun Bocek <tayfunbocek@live.ca>",
"download_url": "https://files.pythonhosted.org/packages/5f/76/b9db7790a78c9d45d53b98326029a3f6969710c95b9a447f1fd18e2382eb/vshieldpy-0.0.1.tar.gz",
"platform": null,
"description": "# vshieldpy\nA library designed to ease the use of the vShield API when using python.\nAlmost all functionality of the API is implemented, and with proper exceptions.\n\n[](https://github.com/astral-sh/ruff)\n[](https://vshieldpy.readthedocs.io/en/latest)\n[](https://github.com/airblast-dev/vshieldpy/actions/workflows/python-package.yml)\n[](https://opensource.org/licenses/MIT)\n\n> **_NOTE:_** This is an unofficial library for the vShield API. There-for vShield is not responsible for any issues regarding this library.\n\n[](https://vshield.com)\n\n## Supported Products:\n\nAll products do have support, however virtual servers (VPS, VDS and VDS-PRO)\nhave priority in testing and ease of use as that is what I can test for. \n\n## Documentation:\n\n### Online Version:\n\nYou can read the online version of the documentation [here](https://vshieldpy.readthedocs.io/en/latest/). You can also download the offline version from the documentation page if preferred.\n\n### Building it yourself:\n\nAfter cloning the repository, you must install the library with the \"docs\" tag.\n```bash\npython -m pip install \".[docs]\"\n```\nOnce it is done, all of the dependencies required to build the documentation will be installed.\n\nYou can now build the documentation with a single command.\n```bash\npython -m sphinx docs/ docs/_build\n```\n\nThe built documentation will be stored in the `docs/_build` directory of the project. \nNow you can simply open the `index.html` file in your browser of choice, and get started.\n\n\n## Examples:\n\n### REPL:\nExample for creating a client and sending a request to check the accounts current balance.\n\t\t\n```python-repl\n>>> # For use via the repl, \"python -m asyncio\" is more practical since its easier to use with async functions.\n>>> from vshieldpy import Client\n>>> client = Client(\"YOUR_TOKEN\")\n>>> await client.fetch_balance()\n'0.00'\n```\n\n> **_NOTE:_** For an implementation example in an application such as a discord bot, feel free to check out the [examples](examples/README.md).\n\n## Contribution:\nThe library does cover all API paths, however, there are a few small things missing.\n- Setting a wallpaper for a server. (This is only doable if you have reseller access)\n- Tasks are not stored in the instance of a server, said tasks are only returned by `/server/getInfo/<server_id>`.\n- The ease of use of the library might be lacking for various use cases such as hosting a reseller website. I am open to ways this can be improved.\n- Implementing testing for exceptions. Most important ones are already implemented, however a few (mainly parameter exceptions) are not tested.\n\nFor non-breaking and/or small changes feel free to create a PR. If not create an issue so a solution can be discussed.\n\nYou can install all the dependencies needed for development using the \"dev\" tag as shown below.\n```bash\npip install \".[dev]\"\n```\nThis will install the dev dependencies needed for testing, linting, and formatting.\n\nFor formatting and linting [ruff](https://github.com/astral-sh/ruff) is used.\n\nYou can run `python -m ruff check`, and `python -m ruff format` in the project to check if there is any issues.\n\nFor testing [pytest](https://github.com/pytest-dev/pytest) is used.\n\nYou can simply run `python -m pytest` in the project directory to start the tests.\n",
"bugtrack_url": null,
"license": "",
"summary": "Python library for interacting with the vShield API.",
"version": "0.0.1",
"project_urls": {
"Docs": "https://vshieldpy.readthedocs.io/en/latest/",
"Homepage": "https://github.com/airblast-dev/vshieldpy",
"Issues": "https://github.com/airblast-dev/vshieldpy/issues"
},
"split_keywords": [
"servers",
"virtaul server",
"vps",
"vshield",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad3010501153848a7b16725ce02683b4a317f5ff8da59dbc34a6bb600c4ca211",
"md5": "dac3dd6223772e6cd9cd5eb7c8b85ad0",
"sha256": "7963a6d733ea782101af7aa35335eb979a9d209da6174a8042090647697fc60c"
},
"downloads": -1,
"filename": "vshieldpy-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dac3dd6223772e6cd9cd5eb7c8b85ad0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 28846,
"upload_time": "2024-03-13T19:11:50",
"upload_time_iso_8601": "2024-03-13T19:11:50.132048Z",
"url": "https://files.pythonhosted.org/packages/ad/30/10501153848a7b16725ce02683b4a317f5ff8da59dbc34a6bb600c4ca211/vshieldpy-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f76b9db7790a78c9d45d53b98326029a3f6969710c95b9a447f1fd18e2382eb",
"md5": "16445ac2a54db316367733d0a0676a1a",
"sha256": "0868e224a8c36f67ff7471f34df1f725927905caea1fdaf4395ada5fb8915c17"
},
"downloads": -1,
"filename": "vshieldpy-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "16445ac2a54db316367733d0a0676a1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 30591,
"upload_time": "2024-03-13T19:11:58",
"upload_time_iso_8601": "2024-03-13T19:11:58.985462Z",
"url": "https://files.pythonhosted.org/packages/5f/76/b9db7790a78c9d45d53b98326029a3f6969710c95b9a447f1fd18e2382eb/vshieldpy-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 19:11:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "airblast-dev",
"github_project": "vshieldpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vshieldpy"
}
