leesah-game

Name	leesah-game JSON
Version	0.1.0 JSON
	download
home_page	https://github.com/navikt/leesah-game-python
Summary	Leesah er et Pythonbibliotek for å spille det hendelsedrevet applikasjonsutviklingspillet Leesah Game
upload_time	2024-02-22 14:28:18
maintainer
docs_url	None
author	NAV
requires_python	>=3.11,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # LEESAH Python

> Leesah-game er et hendelsedrevet applikasjonsutviklingspill som utfordrer spillerne til å bygge en hendelsedrevet applikasjon. 
> Applikasjonen håndterer forskjellige typer oppgaver som den mottar som hendelser på en Kafka-basert hendelsestrøm. 
> Oppgavene varierer fra veldig enkle til mer komplekse.

Python-bibliotek for å spille LEESAH!

## Kom i gang

Det finnes to versjoner av Leesah-game!
En hvor man lager en applikasjon som kjører på Nais, og en hvor man spiller lokalt direkte fra terminalen sin.
Dette biblioteket kan brukes i begge versjoner, men denne dokumentasjonen dekker kun lokal spilling.
Vi har et eget template-repo som ligger under [navikt/leesah-game-template-go](https://github.com/navikt/leesah-game-template-go) for å spille Nais-versjonen.

### Hent credentials

Sertifikater for å koble seg på Kafka ligger tilgjengelig på [leesah-game-cert.ekstern.dev.nav.no/certs](https://leesah-game-cert.ekstern.dev.nav.no/certs), brukernavn og passord skal du få utdelt.
Du kan også bruke kommandoen nedenfor:

```bash
wget --user <username> --password <password> -O leesah-creds.zip https://leesah-game-cert.ekstern.dev.nav.no/certs && unzip leesah-creds.zip 
```

### Eksempelkode

Nedenfor er det et fungerende eksempel som svarer på lagregistreringsspørsmålet med et navn du velger, og en farge du velger:

```python
"""The Leesah quiz game client.

# 1. Ensure credential files are in the certs directory
# 2. Set `TEAM_NAME` to your preferred team name
# 3. Set `HEX_CODE` to your preferred team color
"""
import leesah

TEAM_NAME = "CHANGE ME"
HEX_CODE = "#0DBABE"


def handle_questions(question: leesah.Question):
    """Call when a question is received from the stream.

    The return value is your answer to the question.
    """
    print(f"Received question: {question}")
    if question.category == "team-registration":
        return HEX_CODE


rapid = leesah.QuizRapid(TEAM_NAME)
rapid.run(handle_questions)

```

## Kjør lokalt

Vi anbefaler at du bruker et virtuelt miljø for å kjøre koden din, som for eksempel [Venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/).

**For macOS/Linux**
```shell
cd leesah-game-starter
python3 -m venv venv
source ./venv/bin/activate
```

**For Windows**
```shell
cd leesah-game-starter
python3 -m venv venv
.\venv\Scripts\activate
```

Er kun en avhengighet du trenger, og det er [leesah](https://pypi.org/project/leesah/).

```shell
python3 -m pip install leesah
```

Kjør koden din med:

```shell
python3 main.py
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/navikt/leesah-game-python",
    "name": "leesah-game",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "NAV",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/20/e4/64868bb3b08493f80319bbae1ed5e5823fe877afea3eb41ac30574585437/leesah_game-0.1.0.tar.gz",
    "platform": null,
    "description": "# LEESAH Python\n\n> Leesah-game er et hendelsedrevet applikasjonsutviklingspill som utfordrer spillerne til \u00e5 bygge en hendelsedrevet applikasjon. \n> Applikasjonen h\u00e5ndterer forskjellige typer oppgaver som den mottar som hendelser p\u00e5 en Kafka-basert hendelsestr\u00f8m. \n> Oppgavene varierer fra veldig enkle til mer komplekse.\n\nPython-bibliotek for \u00e5 spille LEESAH!\n\n## Kom i gang\n\nDet finnes to versjoner av Leesah-game!\nEn hvor man lager en applikasjon som kj\u00f8rer p\u00e5 Nais, og en hvor man spiller lokalt direkte fra terminalen sin.\nDette biblioteket kan brukes i begge versjoner, men denne dokumentasjonen dekker kun lokal spilling.\nVi har et eget template-repo som ligger under [navikt/leesah-game-template-go](https://github.com/navikt/leesah-game-template-go) for \u00e5 spille Nais-versjonen.\n\n### Hent credentials\n\nSertifikater for \u00e5 koble seg p\u00e5 Kafka ligger tilgjengelig p\u00e5 [leesah-game-cert.ekstern.dev.nav.no/certs](https://leesah-game-cert.ekstern.dev.nav.no/certs), brukernavn og passord skal du f\u00e5 utdelt.\nDu kan ogs\u00e5 bruke kommandoen nedenfor:\n\n```bash\nwget --user <username> --password <password> -O leesah-creds.zip https://leesah-game-cert.ekstern.dev.nav.no/certs && unzip leesah-creds.zip \n```\n\n### Eksempelkode\n\nNedenfor er det et fungerende eksempel som svarer p\u00e5 lagregistreringssp\u00f8rsm\u00e5let med et navn du velger, og en farge du velger:\n\n```python\n\"\"\"The Leesah quiz game client.\n\n# 1. Ensure credential files are in the certs directory\n# 2. Set `TEAM_NAME` to your preferred team name\n# 3. Set `HEX_CODE` to your preferred team color\n\"\"\"\nimport leesah\n\nTEAM_NAME = \"CHANGE ME\"\nHEX_CODE = \"#0DBABE\"\n\n\ndef handle_questions(question: leesah.Question):\n    \"\"\"Call when a question is received from the stream.\n\n    The return value is your answer to the question.\n    \"\"\"\n    print(f\"Received question: {question}\")\n    if question.category == \"team-registration\":\n        return HEX_CODE\n\n\nrapid = leesah.QuizRapid(TEAM_NAME)\nrapid.run(handle_questions)\n\n```\n\n## Kj\u00f8r lokalt\n\nVi anbefaler at du bruker et virtuelt milj\u00f8 for \u00e5 kj\u00f8re koden din, som for eksempel [Venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/).\n\n**For macOS/Linux**\n```shell\ncd leesah-game-starter\npython3 -m venv venv\nsource ./venv/bin/activate\n```\n\n**For Windows**\n```shell\ncd leesah-game-starter\npython3 -m venv venv\n.\\venv\\Scripts\\activate\n```\n\nEr kun en avhengighet du trenger, og det er [leesah](https://pypi.org/project/leesah/).\n\n```shell\npython3 -m pip install leesah\n```\n\nKj\u00f8r koden din med:\n\n```shell\npython3 main.py\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Leesah er et Pythonbibliotek for \u00e5 spille det hendelsedrevet applikasjonsutviklingspillet Leesah Game",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/navikt/leesah-game-python",
        "Repository": "https://github.com/navikt/leesah-game-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "51b012e6cdb6a210e472dd19586472cabbf5bc0d1529ea3ef48023543b8a52a6",
                "md5": "c3db0510aec74cd3fa7db768258fc0e2",
                "sha256": "e0f4f8ac6c9c6a09d599c5a8e0f1849fe8b087c662d13d1f6151a7c96a348217"
            },
            "downloads": -1,
            "filename": "leesah_game-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c3db0510aec74cd3fa7db768258fc0e2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 5761,
            "upload_time": "2024-02-22T14:28:17",
            "upload_time_iso_8601": "2024-02-22T14:28:17.549408Z",
            "url": "https://files.pythonhosted.org/packages/51/b0/12e6cdb6a210e472dd19586472cabbf5bc0d1529ea3ef48023543b8a52a6/leesah_game-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "20e464868bb3b08493f80319bbae1ed5e5823fe877afea3eb41ac30574585437",
                "md5": "23c32721311b63b06c5fef19cd7bb126",
                "sha256": "24174c1602e121f461f7400c270d9f6e6e17a27f72883e6da47214925fae9130"
            },
            "downloads": -1,
            "filename": "leesah_game-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "23c32721311b63b06c5fef19cd7bb126",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 4703,
            "upload_time": "2024-02-22T14:28:18",
            "upload_time_iso_8601": "2024-02-22T14:28:18.909024Z",
            "url": "https://files.pythonhosted.org/packages/20/e4/64868bb3b08493f80319bbae1ed5e5823fe877afea3eb41ac30574585437/leesah_game-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-22 14:28:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "navikt",
    "github_project": "leesah-game-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "leesah-game"
}