https://github.com/whist-team/whist-core

Whist rules implementation
https://github.com/whist-team/whist-core

game hacktoberfest pydantic python whist

Last synced: 9 days ago
JSON representation

Whist rules implementation

• Host: GitHub
• URL: https://github.com/whist-team/whist-core
• Owner: Whist-Team
• License: mit
• Created: 2021-04-11T18:37:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T07:20:39.000Z (9 days ago)
• Last Synced: 2024-10-29T08:21:41.988Z (9 days ago)
• Topics: game, hacktoberfest, pydantic, python, whist
• Language: Python
• Homepage:
• Size: 1.49 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![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

```