Metadata-Version: 2.1
Name: TableHockeyTools
Version: 0.1.3.2
Summary: A collection of tools for working with TableHockey data.
Home-page: https://github.com/Benginy-lab/TableHockeyTools.git
Author: Benjamin Nygard
Author-email: Benjamin.nygard13@gmail.com
License: MIT
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4
Requires-Dist: require
Requires-Dist: time

# TableHockeyTools

### this package is in early development and is lacking in functionality, use the better, more updated Readme on [github](https://github.com/Benginy-lab/TableHockeyTools)
**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':

```bash
pip install TableHockeyTools
```

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

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

### this project's source code is found on [github](https://github.com/Benginy-lab/TableHockeyTools) together with pre-releases and new updates.



## Usage

Import the package `THTools` and use the functions as needed:

```python
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](https://github.com/Benginy-lab/TableHockeyTools/blob/main/Manpage.md)

For full documentation of functions, see the [Manpage](https://github.com/Benginy-lab/TableHockeyTools/blob/main/Manpage.md) or visit the [pypi documentation](https://pypi.org/project/TableHockeyTools/) 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`](https://github.com/Benginy-lab/TableHockeyTools/blob/main/THTools/THTools.py) and [`Manpage.md`](https://github.com/Benginy-lab/TableHockeyTools/blob/main/Manpage.md).

## Development

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

```bash
pip install -e .
```

## License

This project is licensed under the MIT License - see the [`LICENSE`](https://github.com/Benginy-lab/TableHockeyTools/blob/main/LICENSE) file in github for details.

## Contact

For questions, reach out via GitHub issues or contact me directly by [Mail](mailto:Benjamin.nygard13@gmail.com).
