Skip to main content

A collection of tools for working with TableHockey data.

Project description

TableHockeyTools

this package is in early development and is lacking in functionality, use the better, more updated Readme on github

TableHockeyTools is a Python package designed to gather data related to Table Hockey. TableHockeyTools provides convenient functions to make working with Table Hockey data straightforward.

Features

  • Data Gathering: Easily gather data related to Table Hockey players, such as points and rank.
  • Examples Provided: The examples folder demonstrates usage for various functions.

Installation

this project can be installed using 'pip':

pip install TableHockeyTools

Alternativeley, you can clone the github repository and install using pip:

git clone https://github.com/Benginy-lab/TableHockeyTools.git
cd TableHockeyTools
pip install .

this project's source code is found on github together with pre-releases and new updates.

Usage

Import the package THTools and use the functions as needed:

import THTools as tht

# Example usage
player_names = ['Evigeny Matansev', 'Rainers Kalnins']
player_ids = []
for player_name in player_names:
    player_ids.append(tht.GetPlayerID(player_name))
for player_id, player_name in zip(player_ids, player_names):
    player_points = tht.GetPlayerPoints(player_id)
    print(f"{player_name} has {player_points} points.")

Check out the examples folder for more detailed usage.

Documentation

The Github Manpage

For full documentation of functions, see the Manpage or visit the pypi documentation if available, the documentation is not yet any different from this readme.

Example Functions

  • GetPlayerID(Name): retrieves the ITHF player ID for a given player name.
  • GetPlayerPoints(ID): retrieves the points for a given player ID.
  • GetPlayerRank(ID): retrieves the rank for a given player ID.

Each function documented in Github at THTools/THTools.py and Manpage.md.

Development

Feel free to contribute! To install the package in development mode, simply add -e:

pip install -e .

License

This project is licensed under the MIT License - see the LICENSE file in github for details.

Contact

For questions, reach out via GitHub issues or contact me directly by Mail.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tablehockeytools-0.1.3.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

TableHockeyTools-0.1.3.1-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file tablehockeytools-0.1.3.1.tar.gz.

File metadata

  • Download URL: tablehockeytools-0.1.3.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for tablehockeytools-0.1.3.1.tar.gz
Algorithm Hash digest
SHA256 e863ac094dd0c94e2416750229f1c236896d2d6dc0b36bb3d1d9256292bb866b
MD5 cf17f5c0bcd48098488c568c1d4de426
BLAKE2b-256 2e62ee4437fdc8df1fb0e61d72d45904863d727d80aaba000b00d86b49e56f29

See more details on using hashes here.

File details

Details for the file TableHockeyTools-0.1.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for TableHockeyTools-0.1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4de5e30926af29a687479930404577d7d2703ebb98d3ae26ea6feaebe1124c7a
MD5 b14d1ea5ac7185eed89c4857ced7dab0
BLAKE2b-256 78d42934ffe81893a6d6d1ad020574116ec0d4c512fb5816ae3ab671579c29d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page