# pyvts
[](https://opensource.org/licenses/MIT) [](https://github.com/Genteki/pyvts/issues) [](https://circleci.com/gh/Genteki/pyvts)
[](https://codecov.io/gh/Genteki/pyvts)
[](https://pypi.org/project/pyvts/)
[](https://genteki.github.io/pyvts)
A python library for interacting with the [VTube Studio API](https://github.com/DenchiSoft/VTubeStudio).
## Overview
`pyvts` is a python library for interacting with the [VTube Studio API](https://github.com/DenchiSoft/VTubeStudio).
You can easily use the library to develop VTubeStudio Plugin to achieve your goals. For example, adding new tracking parameters to enable more actions on live2d avatars.
## Quick Start
### Installation
```shell
pip install pyvts
```
### Get Started
First import library you need,
```python
import pyvts
import asyncio
```
Create an instance with default values, and do whateveer you want!
```python
async def main():
vts = pyvts.vts()
await vts.connect()
# Implement what you want to do
await vts.close()
if __name__ == "__main__":
asyncio.run(main())
```
To see more examples, you could visit [tutorial](https://genteki.github.io/pyvts/toctree2_tutorial.html) in documentation.
## Contributing
Contribution is welcome. Please follow the guide of [CONTRIBUING.md](CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/Genteki/pyvts",
"name": "pyvts",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "vtubestudio",
"author": "Genteki Zhang",
"author_email": "zhangkaiyuan.null@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0c/c7/be53a7964c0d5e108c416bfdea432a4451fd4d8e03f18b5877376548f016/pyvts-0.3.3.tar.gz",
"platform": null,
"description": "# pyvts\n\n[](https://opensource.org/licenses/MIT) [](https://github.com/Genteki/pyvts/issues) [](https://circleci.com/gh/Genteki/pyvts)\n[](https://codecov.io/gh/Genteki/pyvts)\n[](https://pypi.org/project/pyvts/)\n[](https://genteki.github.io/pyvts)\n\nA python library for interacting with the [VTube Studio API](https://github.com/DenchiSoft/VTubeStudio).\n\n## Overview\n\n`pyvts` is a python library for interacting with the [VTube Studio API](https://github.com/DenchiSoft/VTubeStudio).\n\nYou can easily use the library to develop VTubeStudio Plugin to achieve your goals. For example, adding new tracking parameters to enable more actions on live2d avatars.\n\n## Quick Start\n\n### Installation\n\n```shell\npip install pyvts \n```\n\n### Get Started\n\nFirst import library you need,\n\n```python\nimport pyvts\nimport asyncio\n```\n\nCreate an instance with default values, and do whateveer you want!\n\n```python\nasync def main():\n vts = pyvts.vts()\n await vts.connect()\n # Implement what you want to do\n await vts.close()\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\nTo see more examples, you could visit [tutorial](https://genteki.github.io/pyvts/toctree2_tutorial.html) in documentation.\n\n## Contributing\n\nContribution is welcome. Please follow the guide of [CONTRIBUING.md](CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library for interacting with the VTube Studio API",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/Genteki/pyvts"
},
"split_keywords": [
"vtubestudio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cc7be53a7964c0d5e108c416bfdea432a4451fd4d8e03f18b5877376548f016",
"md5": "a9d52e3cdfd77f97bbfde76f9fe3a739",
"sha256": "decf3299a391ce2e38ffcc3fb2caf71f06b27b9ca2b7581dc5a97e62620da2c4"
},
"downloads": -1,
"filename": "pyvts-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "a9d52e3cdfd77f97bbfde76f9fe3a739",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11655,
"upload_time": "2024-09-10T08:16:27",
"upload_time_iso_8601": "2024-09-10T08:16:27.494091Z",
"url": "https://files.pythonhosted.org/packages/0c/c7/be53a7964c0d5e108c416bfdea432a4451fd4d8e03f18b5877376548f016/pyvts-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-10 08:16:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Genteki",
"github_project": "pyvts",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "pyvts"
}
JSON
