Metadata-Version: 2.1
Name: whist-core
Version: 0.8.0
Summary: Whist rules implementation
Home-page: https://github.com/Whist-Team/Whist-Core
License: MIT
Keywords: game,whist
Author: Whist-Team
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pydantic (>=1.10,<2.0)
Project-URL: Bug Tracker, https://github.com/Whist-Team/Whist-Core/issues
Project-URL: Documentation, https://whist-core.readthedocs.io
Project-URL: Repository, https://github.com/Whist-Team/Whist-Core
Description-Content-Type: text/markdown

[![Documentation Status](https://readthedocs.org/projects/pip/badge/?version=stable)](https://whist-core.readthedocs.io/en/latest/)
[![codecov](https://codecov.io/gh/Whist-Team/Whist-Core/branch/main/graph/badge.svg)](https://codecov.io/gh/Whist-Team/Whist-Core)
![PyPI](https://img.shields.io/pypi/v/whist-core)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/whist-core)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/whist-core)
![GitHub repo size](https://img.shields.io/github/repo-size/whist-team/whist-core)
![Lines of code](https://img.shields.io/tokei/lines/github/whist-team/whist-core)
![PyPI - Downloads](https://img.shields.io/pypi/dm/whist-core)
![PyPI - License](https://img.shields.io/pypi/l/whist-core)

# Whist-Core
Whist rules implementation

## Development

### Setup
You need [Poetry](https://python-poetry.org/) for development.
```bash
# Create venv and install deps
poetry install
```
The Python virtual environment will be created in the `.venv` directory.

### Run tests/lint
```bash
# Run tests (in venv)
python -m pytest # or pylint...
# OR
poetry run python -m pytest
```

### Build
Generates `sdist` and `bdist_wheel`.
```bash
poetry build
```

### Publish
You need the environment variable `POETRY_PYPI_TOKEN_PYPI` filled with a PyPI token.
```bash
poetry build
poetry publish
# OR
poetry publish --build
```

