fivbvis


Namefivbvis JSON
Version 0.3 PyPI version JSON
download
home_pagehttps://github.com/claromes/fivbvis
SummaryPython client for the Volleyball Information System (FIVB VIS)
upload_time2024-02-09 15:44:02
maintainer
docs_urlNone
authorClaromes
requires_python>=3.8
licenseGPLv3
keywords fivbvis fivb volleyball beachvolleyball sports datasets analytics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # FIVB VIS Python Client

[![PyPI](https://img.shields.io/pypi/v/fivbvis)](https://pypi.org/project/fivbvis/) ![Development Status :: 4 - Beta](https://img.shields.io/badge/development_status-4_--_Beta-yellow) [![PyPI](https://img.shields.io/pypi/dm/fivbvis.svg)](https://pypistats.org/packages/fivbvis)

The package `fivbvis` is a Python client library for easy integration with the [Volleyball Information System Web Service](https://www.fivb.org/VisSDK/VisWebService) of the Fédération Internationale de Volleyball (FIVB), handling public data and only documented requests, and providing XML and JSON responses.

The VIS Web Service enables third party applications to access all public data about volleyball, beach volleyball and other events. This client facilitates access for Python programmers, enabling access to data such as articles, matches, events, images, players, player rankings, and tournaments.

It is compatible with Python versions 3.8 and above, but it has been tested specifically on versions 3.8 and 3.11.

## Installation

```shell
pip install fivbvis
```

## Usage
Basic example:

```python
from fivbvis import Volleyball

v = Volleyball()
v.getVolleyMatch(9211, fields="City CountryName DateLocal TeamNameA TeamNameB")
```
XML response:

```xml
<VolleyballMatch
   City="Nagoya"
   CountryName="Japan"
   DateLocal="2018-10-07"
   TeamNameA="Germany"
   TeamNameB="Brazil"
   No="9211"
   Version="2393792"/>
```

## Documentation

The documentation is based on FIVB VIS Web Service requests. It is simple and includes only requests documented by the FIVB developer team. Check the [docs folder](https://github.com/claromes/fivbvis/blob/main/docs/documentation.md) for detailed information and examples.

[This list contains all available requests via VIS web service](https://www.fivb.org/VisSDK/VisWebService/#RequestList.html); those with links are documented. Currently, this Python client is read-only.


## Author

[Claromes](https://claromes.com)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/claromes/fivbvis",
    "name": "fivbvis",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "fivbvis fivb volleyball beachvolleyball sports datasets analytics",
    "author": "Claromes",
    "author_email": "support@claromes.com",
    "download_url": "https://files.pythonhosted.org/packages/1b/9f/577b6b26f7a3275e9429546423cd58bb021aed672a77e133788be9a75741/fivbvis-0.3.tar.gz",
    "platform": null,
    "description": "# FIVB VIS Python Client\n\n[![PyPI](https://img.shields.io/pypi/v/fivbvis)](https://pypi.org/project/fivbvis/) ![Development Status :: 4 - Beta](https://img.shields.io/badge/development_status-4_--_Beta-yellow) [![PyPI](https://img.shields.io/pypi/dm/fivbvis.svg)](https://pypistats.org/packages/fivbvis)\n\nThe package `fivbvis` is a Python client library for easy integration with the [Volleyball Information System Web Service](https://www.fivb.org/VisSDK/VisWebService) of the F\u00e9d\u00e9ration Internationale de Volleyball (FIVB), handling public data and only documented requests, and providing XML and JSON responses.\n\nThe VIS Web Service enables third party applications to access all public data about volleyball, beach volleyball and other events. This client facilitates access for Python programmers, enabling access to data such as articles, matches, events, images, players, player rankings, and tournaments.\n\nIt is compatible with Python versions 3.8 and above, but it has been tested specifically on versions 3.8 and 3.11.\n\n## Installation\n\n```shell\npip install fivbvis\n```\n\n## Usage\nBasic example:\n\n```python\nfrom fivbvis import Volleyball\n\nv = Volleyball()\nv.getVolleyMatch(9211, fields=\"City CountryName DateLocal TeamNameA TeamNameB\")\n```\nXML response:\n\n```xml\n<VolleyballMatch\n   City=\"Nagoya\"\n   CountryName=\"Japan\"\n   DateLocal=\"2018-10-07\"\n   TeamNameA=\"Germany\"\n   TeamNameB=\"Brazil\"\n   No=\"9211\"\n   Version=\"2393792\"/>\n```\n\n## Documentation\n\nThe documentation is based on FIVB VIS Web Service requests. It is simple and includes only requests documented by the FIVB developer team. Check the [docs folder](https://github.com/claromes/fivbvis/blob/main/docs/documentation.md) for detailed information and examples.\n\n[This list contains all available requests via VIS web service](https://www.fivb.org/VisSDK/VisWebService/#RequestList.html); those with links are documented. Currently, this Python client is read-only.\n\n\n## Author\n\n[Claromes](https://claromes.com)\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Python client for the Volleyball Information System (FIVB VIS)",
    "version": "0.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/claromes/fivbvis/issues",
        "Documentation": "https://github.com/claromes/fivbvis/blob/main/docs/documentation.md",
        "Homepage": "https://github.com/claromes/fivbvis",
        "Releases": "https://github.com/claromes/fivbvis/releases"
    },
    "split_keywords": [
        "fivbvis",
        "fivb",
        "volleyball",
        "beachvolleyball",
        "sports",
        "datasets",
        "analytics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1b1b9e6c14a7afed9c09c492cfc19c2c7fa7f0d14e1bcf1e9f0ea1a50f25ebd3",
                "md5": "ba67a524c29e928e5dbaf90c1735cbe5",
                "sha256": "4f143db05071bae00654c4a9e51f8d5a3956a6c2aab32314d04d1426cb6d987a"
            },
            "downloads": -1,
            "filename": "fivbvis-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ba67a524c29e928e5dbaf90c1735cbe5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16318,
            "upload_time": "2024-02-09T15:44:01",
            "upload_time_iso_8601": "2024-02-09T15:44:01.186004Z",
            "url": "https://files.pythonhosted.org/packages/1b/1b/9e6c14a7afed9c09c492cfc19c2c7fa7f0d14e1bcf1e9f0ea1a50f25ebd3/fivbvis-0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1b9f577b6b26f7a3275e9429546423cd58bb021aed672a77e133788be9a75741",
                "md5": "a986acf693a3068c5e7ca3255558d877",
                "sha256": "9d8217b37e5f9f1c4918c1fa37a852f121c8290682f8a3b418b53a467da59f12"
            },
            "downloads": -1,
            "filename": "fivbvis-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a986acf693a3068c5e7ca3255558d877",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 15894,
            "upload_time": "2024-02-09T15:44:02",
            "upload_time_iso_8601": "2024-02-09T15:44:02.538518Z",
            "url": "https://files.pythonhosted.org/packages/1b/9f/577b6b26f7a3275e9429546423cd58bb021aed672a77e133788be9a75741/fivbvis-0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-09 15:44:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "claromes",
    "github_project": "fivbvis",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "fivbvis"
}
        
Elapsed time: 0.18799s