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.2.tar.gz (9.5 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.2-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tablehockeytools-0.1.3.2.tar.gz
  • Upload date:
  • Size: 9.5 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.2.tar.gz
Algorithm Hash digest
SHA256 8bf8c95f77e26c7979f603acf9e0dc734f03cc6d9b959b9787425e6e0561ef3e
MD5 30e3bcc8d56c30f4eba803d35ced42c8
BLAKE2b-256 02cbc0d7fd30248d5757c3600eb6a02289c3b4a5b3cb22d3454a820127bd5d8f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for TableHockeyTools-0.1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ac4a761e8dd26e7243f927ed49b028b3f5ff9ad058e4deb6aa2fd47f3521d3c1
MD5 f61c940ff7f19a5de48b81fc97abd4b5
BLAKE2b-256 334f46764ea0105f6729555b5b3fd2d42b615afbc9f0c18112d4b9d4d75f0605

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