Metadata-Version: 2.1
Name: IHSBotballKit
Version: 1.0.1
Summary: An object-oriented wrapper for the KIPR Botball library with additional functionalities.
Home-page: https://github.com/snow4060
Author: snow4060
Author-email: haoyun807963@gmail.com
License: GPL-3.0
Download-URL: https://github.com/ihsrobotics/IHSBotballKit/archive/refs/tags/1.0.1.tar.gz
Keywords: KIPR,BOTBALL,WOMBAT,LIBKIPR,LIBWALLABY
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE

# MyPythonModule

[![PyPI version](https://badge.fury.io/py/IHSBotballKit.svg)](https://badge.fury.io/py/IHSBotballKit)

An object-oriented wrapper for the KIPR Botball library with additional functionalities.

## Installation

The module is installed using pip:

```bash
pip install IHSBotballKit
```

## Usage

Documentation can be found in the source code or stubs. Examples use cases are provided in the examples folder.

## Contributing

Contributions are welcome! Please follow the following style guides:

- Use standard python syntax and naming conventions(e.g. snake_case for variables, CamelCase for classes).
-
- All importable members must be documented using [Google style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
- Type hinting is not required but strongly recommended whenever possible.
- It is recommended to use a static type checker such as [mypy](https://mypy.readthedocs.io/en/stable/) while contributing to the package.
- Create stubs in the stubs folder after you've made all the changes. A good way to do that is to use [mypy's stubgen](https://mypy.readthedocs.io/en/stable/stubgen.html).
  - note: the stubs generated will have some issues and incomplete typing. It is your job to fix them before committing the code.

    ```bash
    # generate all the stubs at once
    stubgen -p ./IHSBotballKit -v --include-docstrings -o ./stubs
    # generate stubs for one (or more) file
    stubgen ./IHSBotballKit/file.py ./IHSBotballKit/file2.py -v --include-docstrings -0 ./stubs
    ```
- Chores:
  - Update version number in `__init__.py` according to semantic versioning guidelines.
  - Create new release on GitHub.
  - Update relevant information in `setup.py`, namely version, download url, and dependencies.
  - Run the following to upload the new version to pypi.
    ```bash
    rm -rf dist && python3 setup.py sdist
    twine check dist/* # make sure there are no problems in the uploaded file(s)
    twine upload dist/*
    ```

## Acknowledgements

- [Botballkit](https://pypi.org/project/BotballKit/) - For inspiration and some functionality.

## Issues

If you encounter any issues, please create a new issue here. Please be detailed in the description of the issue, include relevant background information (e.g. operating system, software versions), expected behavior, and how to reproduce the issue.


