Metadata-Version: 2.4
Name: probotanki-lib
Version: 2.2.4
Summary: Core library for ProboTanki providing networking modules and packet handling utilities.
Author-email: Teinc3 <teinc3@gmail.com>
License: Proprietary
Project-URL: Homepage, https://github.com/Teinc3/ProboTanki-Lib
Project-URL: Documentation, https://deepwiki.com/Teinc3/ProboTanki-Lib
Project-URL: Issue Tracker, https://github.com/Teinc3/ProboTanki-Lib/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pysocks
Requires-Dist: aiosocks
Dynamic: requires-dist


# ProboTanki-Lib
![Latest Tag](https://img.shields.io/github/v/tag/Teinc3/ProboTanki-Lib)
[![PyPI version](https://badge.fury.io/py/probotanki-lib.svg)](https://badge.fury.io/py/probotanki-lib)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Teinc3/ProboTanki-Lib)

A core networking ~~library~~ framework for ProTanki, providing packet handling modules & utilities.


## Dependencies
Each public tagged release of this library provides pre-built wheels on Windows, Linux and macOS for supported Python versions, which when installed bundles all necessary dependencies.

However, for those who wish to build the library from source or contribute to its development,
the following dependencies are required for a local environment:

### Runtime
- Python >=3.10 (SOCKS5 functionality unavailable for versions >= 3.12)

### Package Dependencies
- `pysocks`
- `aiosocks`

### Dev Dependencies
- Any C++ Compiler for building wheels for the cryptographic security module.


## Installation
This library is available on PyPI! You can now access it at https://pypi.org/project/probotanki-lib/

Like any other Python package, you can install it using pip:
```bash
pip install probotanki-lib
```

Note that the namespace used for the package would be `pbtlib`.

### Development Version

To install it, clone the repository to a local directory in your project.
```bash
cd /path/to/your/project
mkdir -p pbtlib
git clone https://github.com/Teinc3/ProboTanki-Lib.git
```
*OR*
```bash
git clone git@github.com:Teinc3/ProboTanki-Lib.git
```

Then, add the path to your requirements:
```pip-requirements
-e ./pbtlib

# Other requirements you might need...
```
*OR*
```bash
pip install -e ./pbtlib
```

This will install the library in your Python environment in Editable Mode,
allowing you to make changes to the library without needing to reinstall it every time.


## License and Contributing
This library is not licensed as it is subject to the terms of ProTanki Online. It is instead marked as "Proprietary".

If you want to contribute to this library, please fork the repository and create a pull request with your changes.
Please make sure to follow the coding style and conventions used in the library.

If you have any questions or suggestions, feel free to open an issue in the repository.
