code-battles-cli 1.1.1__tar.gz

code_battles_cli-1.1.1/.gitignore

@@ -0,0 +1,13 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv
+
+bots
+code-battles.json

code_battles_cli-1.1.1/.python-version

@@ -0,0 +1 @@
+3.12.2

code_battles_cli-1.1.1/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2024 Noam Zaks and Code Battles Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

code_battles_cli-1.1.1/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.3
+Name: code-battles-cli
+Version: 1.1.1
+Summary: A CLI for competitors in any Code Battles event!
+Requires-Python: >=3.8
+Requires-Dist: click>=8.1.7
+Requires-Dist: google-cloud-firestore>=2.19.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.9.3
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://github.com/noamzaks/code-battles/assets/63877260/b330aa14-7003-4204-8907-e77a5c6e8d81" height="140">
+</p>
+<h1 align="center">
+  Code Battles CLI
+  <br />
+  <img src="https://img.shields.io/pypi/v/code-battles-cli">
+  <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg">
+</h1>
+
+<p align="center">
+    A CLI for competitors in any Code Battles event!
+</p>
+<p align="center">
+    🏃 <a href="#getting-started">Getting Started</a>
+    &nbsp;&middot&nbsp;
+    💡 <a href="#features">Features</a>
+    &nbsp;&middot&nbsp;
+    🚗 <a href="#roadmap">Roadmap</a>
+</p>
+
+# Getting Started
+
+-   Install the library by running `pip install code-battles-cli`.
+-   Make sure you have the Python scripts folder in your `PATH` by running `code-battles --help`.
+-   If that fails, run `py -m code_battles_cli --help`.
+
+The first time you run any command you will be asked for your URL, username and password, and they'll be saved in a `code-battles.json` file for successive calls.
+
+# Features
+
+## Downloading the bots
+
+You can download all of the bots your team has by running `code-battles download`.
+
+## Uploading a bot
+
+You can update a bot in the website by running `code-battles upload bots/example.py` (in this case the bot's name will be `example`).
+
+If you want to choose a custom bot name, you can run `code-battles upload bots/example.py -n myamazingbot`.
+
+## Running a simulation
+
+You can run a simulation by running `code-battles run NYC bots/example.py bots/another_example.py`, where `NYC` is an example of a map.
+
+You will probably find the scripting API nicer to work with if you want to run simulations locally.
+
+## Usage in scripts
+
+You can import the `code_battles_cli.api` module and utilize its `Client` class to hack Code Battles for your needs!
+
+Example:
+
+```python
+from code_battles_cli.api import Client
+
+client = Client()
+
+print(client.get_bots())
+print(client.run_simulation("NYC", ["bots/example.py", "bots/another_example.py"]))
+```
+
+# Roadmap
+
+-   [x] Download bots.
+-   [x] Upload bots.
+-   [x] Run no-UI simulations locally.
+-   [x] Be usable in scripts.

code_battles_cli-1.1.1/README.md

@@ -0,0 +1,69 @@
+<p align="center">
+  <img src="https://github.com/noamzaks/code-battles/assets/63877260/b330aa14-7003-4204-8907-e77a5c6e8d81" height="140">
+</p>
+<h1 align="center">
+  Code Battles CLI
+  <br />
+  <img src="https://img.shields.io/pypi/v/code-battles-cli">
+  <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg">
+</h1>
+
+<p align="center">
+    A CLI for competitors in any Code Battles event!
+</p>
+<p align="center">
+    🏃 <a href="#getting-started">Getting Started</a>
+    &nbsp;&middot&nbsp;
+    💡 <a href="#features">Features</a>
+    &nbsp;&middot&nbsp;
+    🚗 <a href="#roadmap">Roadmap</a>
+</p>
+
+# Getting Started
+
+-   Install the library by running `pip install code-battles-cli`.
+-   Make sure you have the Python scripts folder in your `PATH` by running `code-battles --help`.
+-   If that fails, run `py -m code_battles_cli --help`.
+
+The first time you run any command you will be asked for your URL, username and password, and they'll be saved in a `code-battles.json` file for successive calls.
+
+# Features
+
+## Downloading the bots
+
+You can download all of the bots your team has by running `code-battles download`.
+
+## Uploading a bot
+
+You can update a bot in the website by running `code-battles upload bots/example.py` (in this case the bot's name will be `example`).
+
+If you want to choose a custom bot name, you can run `code-battles upload bots/example.py -n myamazingbot`.
+
+## Running a simulation
+
+You can run a simulation by running `code-battles run NYC bots/example.py bots/another_example.py`, where `NYC` is an example of a map.
+
+You will probably find the scripting API nicer to work with if you want to run simulations locally.
+
+## Usage in scripts
+
+You can import the `code_battles_cli.api` module and utilize its `Client` class to hack Code Battles for your needs!
+
+Example:
+
+```python
+from code_battles_cli.api import Client
+
+client = Client()
+
+print(client.get_bots())
+print(client.run_simulation("NYC", ["bots/example.py", "bots/another_example.py"]))
+```
+
+# Roadmap
+
+-   [x] Download bots.
+-   [x] Upload bots.
+-   [x] Run no-UI simulations locally.
+-   [x] Be usable in scripts.

code_battles_cli-1.1.1/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "code-battles-cli"
+version = "1.1.1"
+description = "A CLI for competitors in any Code Battles event!"
+dependencies = [
+    "requests>=2.32.3",
+    "google-cloud-firestore>=2.19.0",
+    "rich>=13.9.3",
+    "click>=8.1.7",
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+
+[project.scripts]
+"code-battles" = "code_battles_cli:main"
+
+[build-system]
+requires = ["hatchling==1.26.3"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/code_battles_cli"]

code_battles_cli-1.1.1/requirements-dev.lock

@@ -0,0 +1,70 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+cachetools==5.5.0
+    # via google-auth
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.4.0
+    # via requests
+click==8.1.7
+    # via code-battles-cli
+google-api-core==2.21.0
+    # via google-cloud-core
+    # via google-cloud-firestore
+google-auth==2.35.0
+    # via google-api-core
+    # via google-cloud-core
+    # via google-cloud-firestore
+google-cloud-core==2.4.1
+    # via google-cloud-firestore
+google-cloud-firestore==2.19.0
+    # via code-battles-cli
+googleapis-common-protos==1.65.0
+    # via google-api-core
+    # via grpcio-status
+grpcio==1.67.0
+    # via google-api-core
+    # via grpcio-status
+grpcio-status==1.67.0
+    # via google-api-core
+idna==3.10
+    # via requests
+markdown-it-py==3.0.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+proto-plus==1.24.0
+    # via google-api-core
+    # via google-cloud-firestore
+protobuf==5.28.2
+    # via google-api-core
+    # via google-cloud-firestore
+    # via googleapis-common-protos
+    # via grpcio-status
+    # via proto-plus
+pyasn1==0.6.1
+    # via pyasn1-modules
+    # via rsa
+pyasn1-modules==0.4.1
+    # via google-auth
+pygments==2.18.0
+    # via rich
+requests==2.32.3
+    # via code-battles-cli
+    # via google-api-core
+rich==13.9.3
+    # via code-battles-cli
+rsa==4.9
+    # via google-auth
+urllib3==2.2.3
+    # via requests

code_battles_cli-1.1.1/requirements.lock

@@ -0,0 +1,70 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+cachetools==5.5.0
+    # via google-auth
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.4.0
+    # via requests
+click==8.1.7
+    # via code-battles-cli
+google-api-core==2.21.0
+    # via google-cloud-core
+    # via google-cloud-firestore
+google-auth==2.35.0
+    # via google-api-core
+    # via google-cloud-core
+    # via google-cloud-firestore
+google-cloud-core==2.4.1
+    # via google-cloud-firestore
+google-cloud-firestore==2.19.0
+    # via code-battles-cli
+googleapis-common-protos==1.65.0
+    # via google-api-core
+    # via grpcio-status
+grpcio==1.67.0
+    # via google-api-core
+    # via grpcio-status
+grpcio-status==1.67.0
+    # via google-api-core
+idna==3.10
+    # via requests
+markdown-it-py==3.0.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+proto-plus==1.24.0
+    # via google-api-core
+    # via google-cloud-firestore
+protobuf==5.28.2
+    # via google-api-core
+    # via google-cloud-firestore
+    # via googleapis-common-protos
+    # via grpcio-status
+    # via proto-plus
+pyasn1==0.6.1
+    # via pyasn1-modules
+    # via rsa
+pyasn1-modules==0.4.1
+    # via google-auth
+pygments==2.18.0
+    # via rich
+requests==2.32.3
+    # via code-battles-cli
+    # via google-api-core
+rich==13.9.3
+    # via code-battles-cli
+rsa==4.9
+    # via google-auth
+urllib3==2.2.3
+    # via requests

code_battles_cli-1.1.1/src/code_battles_cli/__init__.py

@@ -0,0 +1 @@
+from code_battles_cli.cli import main

code_battles_cli-1.1.1/src/code_battles_cli/__main__.py

@@ -0,0 +1,4 @@
+from code_battles_cli.cli import main
+import sys
+
+sys.exit(main())

code_battles_cli-1.1.1/src/code_battles_cli/api.py

@@ -0,0 +1,346 @@
+"""
+Code Battles Python Client API
+
+Firestore client implementation inspired by https://medium.com/@bobthomas295/client-side-authentication-with-python-firestore-and-firebase-352e484a2634
+"""
+
+import base64
+import datetime
+import logging
+import gzip
+import os
+import json
+import shutil
+import subprocess
+import sys
+from typing import Any, Callable, Dict, List, Optional, Union
+from dataclasses import dataclass
+
+import requests
+from google.oauth2.credentials import Credentials
+from google.cloud.firestore import Client as FirestoreClient
+from rich.prompt import Prompt
+from code_battles_cli.log import console, log, progress
+
+
+SIMULATION_FINISHED_MARK = b"--- SIMULATION FINISHED ---"
+SIMULATION_STEP_MARK = b"__CODE_BATTLES_ADVANCE_STEP"
+
+
+@dataclass
+class LogEntry:
+    step: int
+    text: str
+    color: str
+    player_index: Optional[int]
+
+
+@dataclass
+class SimulationResults:
+    winner_index: int
+    winner: str
+    steps: int
+    logs: List[LogEntry]
+
+
+@dataclass
+class Simulation:
+    map: str
+    player_names: str
+    game: str
+    version: str
+    timestamp: datetime.datetime
+    logs: list
+    decisions: List[bytes]
+    seed: int
+
+    def dump(self):
+        return base64.b64encode(
+            gzip.compress(
+                json.dumps(
+                    {
+                        "map": self.map,
+                        "playerNames": self.player_names,
+                        "game": self.game,
+                        "version": self.version,
+                        "timestamp": self.timestamp.isoformat(),
+                        "logs": self.logs,
+                        "decisions": [
+                            base64.b64encode(decision).decode()
+                            for decision in self.decisions
+                        ],
+                        "seed": self.seed,
+                    }
+                ).encode()
+            )
+        ).decode()
+
+    @staticmethod
+    def load(file: str):
+        contents: Dict[str, Any] = json.loads(gzip.decompress(base64.b64decode(file)))
+        return Simulation(
+            contents["map"],
+            contents["playerNames"],
+            contents["game"],
+            contents["version"],
+            datetime.datetime.fromisoformat(contents["timestamp"]),
+            contents["logs"],
+            [base64.b64decode(decision) for decision in contents["decisions"]],
+            contents["seed"],
+        )
+
+
+class Client:
+    def __init__(
+        self,
+        url: Optional[str] = None,
+        username: Optional[str] = None,
+        password: Optional[str] = None,
+        dump_credentials=True,
+    ):
+        """
+        Creates a client for getting and setting the bots for a Code Battles hosted at `url`
+        and signing in as `username` with `password`.
+        """
+
+        if url is None or username is None or password is None:
+            self._get_credentials()
+        else:
+            self.url = url
+            self.username = username
+            self.password = password
+
+        self._get_firebase_data()
+        self._sign_in()
+
+        if dump_credentials:
+            self._dump_credentials()
+
+    def _get_credentials(self):
+        if os.path.exists("code-battles.json"):
+            try:
+                with open("code-battles.json", "r") as f:
+                    configuration = json.load(f)
+                self.url: str = configuration["url"]
+                self.username: str = configuration["username"]
+                self.password: str = configuration["password"]
+            except Exception:
+                pass
+
+        if (
+            not hasattr(self, "url")
+            or not hasattr(self, "username")
+            or not hasattr(self, "password")
+        ):
+            self.url = Prompt.ask("Enter your competition's URL", console=console)
+
+            if not self.url.startswith("https://"):
+                log.warning("Your URL should most likely start with 'https://'.")
+            if not self.url.endswith(".web.app"):
+                log.warning("Your URL should most likely end with '.web.app'.")
+
+            self.username = Prompt.ask("Enter your team's username", console=console)
+
+            if not self.username == self.username.lower():
+                log.warning("Your username should most likely be lowercased.")
+
+            self.password = Prompt.ask(
+                "Enter your team's password", console=console, password=True
+            )
+
+    def _dump_credentials(self):
+        with open("code-battles.json", "w") as f:
+            json.dump(
+                {"url": self.url, "username": self.username, "password": self.password},
+                f,
+            )
+        log.info(
+            "Credentials were dumped to `code-battles.json`. Make sure other teams don't have access to this file!"
+        )
+
+    def _get_firebase_data(self):
+        configuration = requests.get(self.url + "/firebase-configuration.json").json()
+        self.firebase_api_key: str = configuration["apiKey"]
+        self.firebase_project_id: str = configuration["projectId"]
+        # print(
+        #     f"Got API Key: '{self.firebase_api_key}' and Project ID: '{self.firebase_project_id}'"
+        # )
+
+    def _sign_in(self, email_domain="gmail.com"):
+        try:
+            response = requests.post(
+                f"https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={self.firebase_api_key}",
+                json={
+                    "email": self.username + "@" + email_domain,
+                    "password": self.password,
+                    "returnSecureToken": True,
+                },
+            ).json()
+        except Exception:
+            raise Exception(
+                "Sign in failed! Make sure the username and password are correct."
+            )
+
+        self.credentials = Credentials(response["idToken"], response["refreshToken"])
+        self.client = FirestoreClient(self.firebase_project_id, self.credentials)
+        self.document = self.client.document(f"bots/{self.username}")
+
+    def get_bots(self) -> Dict[str, str]:
+        """Returns a mapping from a bot's name to their Python code."""
+        return self.document.get().to_dict()
+
+    def set_bots(self, bots: Dict[str, str], merge=True) -> None:
+        """
+        Sets the bots in the website to the specified bots.
+        Doesn't remove any bot unless ``merge`` is ``False``, in which case only bots specified in ``bots`` will remain.
+        """
+        self.document.set(bots, merge)
+
+    def _possibly_download(self, force_download=False):
+        code_directory = os.path.expanduser(
+            f"~/.cache/code-battles/{''.join([c for c in self.url.removeprefix("https").removesuffix(".web.app") if c.isalnum()])}"
+        )
+
+        if force_download and os.path.exists(code_directory):
+            shutil.rmtree(code_directory)
+
+        if not os.path.exists(code_directory):
+            os.makedirs(code_directory)
+
+            with console.status("[blue]Fetching configuration from game website..."):
+                pyscript_configuration = requests.get(self.url + "/config.json").json()
+                logging.info(
+                    f"Fetched configuration containing {len(pyscript_configuration["files"])} game files."
+                )
+
+            with progress:
+                progress_id = progress.add_task(
+                    "[blue]Fetching game files...",
+                    total=len(pyscript_configuration["files"]),
+                )
+
+                for url_path, path in pyscript_configuration["files"].items():
+                    if not path.endswith(".py"):
+                        continue
+
+                    local_path = os.path.join(code_directory, *path.split("/"))
+                    os.makedirs(os.path.dirname(local_path), exist_ok=True)
+                    text = requests.get(self.url + url_path).text
+                    with open(local_path, "w") as f:
+                        f.write(text)
+                    progress.update(progress_id, advance=1)
+                progress.update(progress_id, visible=False)
+
+            logging.info("Finished fetching game files.")
+
+        return code_directory
+
+    def _get_simulation_output(
+        self,
+        p: subprocess.Popen,
+        json_output=False,
+        on_step: Optional[Callable[[], None]] = None,
+    ) -> Union[SimulationResults, str]:
+        while True:
+            line: bytes = p.stdout.readline()
+            line = line.strip()
+            if line == SIMULATION_FINISHED_MARK:
+                break
+            elif line == SIMULATION_STEP_MARK:
+                if on_step is not None:
+                    on_step()
+            elif len(line) != 0:
+                logging.info(line.decode())
+
+        output: bytes = p.stdout.read()
+        if json_output:
+            return output.decode()
+
+        output = json.loads(output)
+        return SimulationResults(
+            output["winner_index"],
+            output["winner"],
+            output["steps"],
+            [
+                LogEntry(
+                    entry["step"], entry["text"], entry["color"], entry["player_index"]
+                )
+                for entry in output["logs"]
+            ],
+        )
+
+    def run_simulation(
+        self,
+        map: str,
+        bot_filenames: List[str],
+        bot_names: Optional[List[str]] = None,
+        seed: Optional[int] = None,
+        force_download=False,
+        json_output=False,
+        on_step: Optional[Callable[[], None]] = None,
+        output_file: Optional[str] = None,
+    ) -> Union[SimulationResults, str]:
+        """
+        Runs the given simulation without UI locally.
+        If ``bot_names`` is not specified, they will be the filenames without the extension.
+
+        If required (or ``force_download``), this method downloads the simulation code from the website.
+
+        If ``json_output`` is ``True``, returns the JSON string of the results instead.
+        """
+
+        if bot_names is None:
+            bot_names = [
+                os.path.splitext(os.path.basename(filename))[0]
+                for filename in bot_filenames
+            ]
+
+        code_directory = self._possibly_download(force_download=force_download)
+
+        p = subprocess.Popen(
+            [
+                sys.executable,
+                os.path.join(code_directory, "main.py"),
+                "simulate",
+                str(seed),
+                str(output_file),
+                map,
+                "-".join(bot_names),
+            ]
+            + [os.path.abspath(f) for f in bot_filenames],
+            env={"PYTHONPATH": os.path.join(code_directory, "code_battles")},
+            stdout=subprocess.PIPE,
+        )
+
+        return self._get_simulation_output(p, json_output, on_step)
+
+    def run_simulation_from_file(
+        self,
+        simulation_file: str,
+        force_download=False,
+        json_output=False,
+        on_step: Optional[Callable[[], None]] = None,
+    ) -> Union[SimulationResults, str]:
+        """
+        Runs the given simulation without UI locally from the given simulation file.
+
+        If required (or ``force_download``), this method downloads the simulation code from the website.
+
+        If ``json_output`` is ``True``, returns the JSON string of the results instead.
+        """
+
+        code_directory = self._possibly_download(force_download=force_download)
+
+        p = subprocess.Popen(
+            [
+                sys.executable,
+                os.path.join(code_directory, "main.py"),
+                "simulate-from-file",
+                simulation_file,
+            ],
+            env={"PYTHONPATH": os.path.join(code_directory, "code_battles")},
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+
+        return self._get_simulation_output(p, json_output, on_step)

code_battles_cli-1.1.1/src/code_battles_cli/cli.py

@@ -0,0 +1,26 @@
+import datetime
+
+import click
+
+
+@click.group()
+@click.version_option(message="%(prog)s %(version)s")
+def cli():
+    pass
+
+
+def main() -> int:
+    from code_battles_cli.log import setup_logging, log
+
+    setup_logging()
+
+    from code_battles_cli.commands.download import download
+    from code_battles_cli.commands.upload import upload
+    from code_battles_cli.commands.run import run
+
+    cli.add_command(download)
+    cli.add_command(upload)
+    cli.add_command(run)
+    cli(standalone_mode=False)
+
+    return 0

code_battles_cli-1.1.1/src/code_battles_cli/commands/download.py

@@ -0,0 +1,61 @@
+import os
+from typing import Optional
+
+import click
+
+from code_battles_cli.api import Client
+from code_battles_cli.log import log
+
+
+@click.command()
+@click.option(
+    "-U",
+    "--url",
+    help="The competition's URL, for example https://code-battles.web.app",
+)
+@click.option("-u", "--username", help="Your team's username, for example mercedes")
+@click.option("-p", "--password", help="Your team's password")
+@click.option(
+    "--dump-credentials",
+    is_flag=True,
+    default=True,
+    show_default=True,
+    help="Dump the URL, username and password to a `code-battles.json` file",
+)
+@click.option(
+    "-b",
+    "--bot",
+    help="A specific bot name to download (downloads everything by default)",
+)
+@click.option(
+    "-d",
+    type=click.Path(file_okay=False),
+    default="bots",
+    show_default=True,
+    help="The directory to download the bots into",
+)
+def download(
+    url: Optional[str],
+    username: Optional[str],
+    password: Optional[str],
+    dump_credentials: bool,
+    bot: Optional[str],
+    d: str,
+):
+    client = Client(url, username, password, dump_credentials)
+    bots = client.get_bots()
+    if bot is not None:
+        if bot not in bots:
+            raise Exception(f"The specified bot '{bot}' does not exist!")
+        bots = {bot: bots[bot]}
+
+    if not os.path.exists(d):
+        os.makedirs(d)
+
+    for bot_name, bot_code in bots.items():
+        with open(os.path.join(d, bot_name + ".py"), "w") as f:
+            f.write(bot_code)
+
+    log.info(
+        f"{len(bots)} {'bots were' if len(bots) != 1 else 'bot was'} downloaded to [blue]{d}[/blue]."
+    )

code_battles_cli-1.1.1/src/code_battles_cli/commands/run.py

@@ -0,0 +1,116 @@
+import time
+import logging
+import sys
+from typing import List, Optional, Tuple
+
+import click
+
+from code_battles_cli.api import Client, Simulation
+from code_battles_cli.log import log, progress
+
+
+@click.command()
+@click.argument("map", required=False)
+@click.argument("bots", nargs=-1)
+@click.option(
+    "-U",
+    "--url",
+    help="The competition's URL, for example https://code-battles.web.app",
+)
+@click.option("-u", "--username", help="Your team's username, for example mercedes")
+@click.option("-p", "--password", help="Your team's password")
+@click.option(
+    "--dump-credentials",
+    is_flag=True,
+    default=True,
+    show_default=True,
+    help="Dump the URL, username and password to a `code-battles.json` file",
+)
+@click.option(
+    "--force-download",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="Re-downloads the simulation code from the website",
+)
+@click.option(
+    "-s", "--seed", type=int, help="Sets the given randomness seed for the simulation"
+)
+@click.option(
+    "-S",
+    "--simulation-file",
+    type=click.Path(exists=True, dir_okay=False),
+    help="Re-downloads the simulation code from the website",
+)
+@click.option(
+    "-O",
+    "output_file",
+    type=click.Path(exists=False),
+    help="Output file to dump the simulation into",
+)
+def run(
+    url: Optional[str],
+    username: Optional[str],
+    password: Optional[str],
+    dump_credentials: bool,
+    map: str,
+    bots: Tuple[str],
+    force_download: bool,
+    seed: Optional[int],
+    simulation_file: Optional[str],
+    output_file: Optional[str],
+):
+    logging.getLogger("rich").setLevel(logging.WARNING)
+    client = Client(url, username, password, dump_credentials)
+    client._possibly_download(force_download)
+    start = time.time()
+
+    with progress:
+        progress_id = progress.add_task("[green]Simulating...", total=None)
+
+        def on_step():
+            progress.update(progress_id, advance=1)
+
+        if simulation_file is not None:
+            assert (
+                map is None
+            ), "The simulation's map is given from the simulation file!"
+            assert (
+                len(bots) == 0
+            ), "The simulation's bots are given from the simulation file!"
+            assert (
+                seed is None
+            ), "The simulation's seed is given from the simulation file!"
+            assert (
+                output_file is None
+            ), "Shouldn't dump simualtion file from existing simulation file!"
+
+            with open(simulation_file, "r") as f:
+                simulation_text = f.read()
+            simulation = Simulation.load(simulation_text)
+            logging.info(
+                f"Detected simulation file of {simulation.game} {simulation.version}"
+            )
+            logging.info(
+                f"Simulation happened in {simulation.map} between {', '.join(simulation.player_names)} with seed {simulation.seed}"
+            )
+            logging.info(f"Simulation contains {len(simulation.decisions)} decisions")
+            progress.update(progress_id, total=len(simulation.decisions) - 1)
+            results = client.run_simulation_from_file(
+                simulation_file, force_download=False, on_step=on_step
+            )
+        else:
+            assert map is not None, "Map is required for simulation!"
+            assert len(bots) > 0, "Bots are required for simulation!"
+
+            results = client.run_simulation(
+                map,
+                list(bots),
+                seed=seed,
+                force_download=False,
+                on_step=on_step,
+                output_file=output_file,
+            )
+    print("The winner is", results.winner, "after", results.steps, "steps.")
+    end = time.time()
+    log.info(f"Simulation took {(end - start) :.2f}s.")

code_battles_cli-1.1.1/src/code_battles_cli/commands/upload.py

@@ -0,0 +1,48 @@
+import os
+from typing import Optional
+
+import click
+
+from code_battles_cli.api import Client
+from code_battles_cli.log import log
+
+
+@click.command()
+@click.option(
+    "-U",
+    "--url",
+    help="The competition's URL, for example https://code-battles.web.app",
+)
+@click.option("-u", "--username", help="Your team's username, for example mercedes")
+@click.option("-p", "--password", help="Your team's password")
+@click.option(
+    "--dump-credentials",
+    is_flag=True,
+    default=True,
+    show_default=True,
+    help="Dump the URL, username and password to a `code-battles.json` file",
+)
+@click.argument(
+    "file",
+    type=click.Path(exists=True, readable=True, dir_okay=False),
+)
+@click.option(
+    "-n",
+    "--name",
+    help="The name of the bot to upload. By default, the file name without the extension will be used as the bot's name.",
+)
+def upload(
+    file: str,
+    name: Optional[str],
+    url: Optional[str],
+    username: Optional[str],
+    password: Optional[str],
+    dump_credentials: bool,
+):
+    bot_name = name if name is not None else os.path.splitext(os.path.basename(file))[0]
+    with open(file, "r") as f:
+        bot_code = f.read()
+
+    client = Client(url, username, password, dump_credentials)
+    client.set_bots({bot_name: bot_code})
+    log.info(f"{bot_code.count('\n') + 1} lines of code were uploaded as '{bot_name}'.")

code_battles_cli-1.1.1/src/code_battles_cli/log.py

@@ -0,0 +1,35 @@
+import os
+import logging
+
+from rich.console import Console
+from rich.progress import BarColumn, MofNCompleteColumn, Progress, TextColumn
+from rich.table import Column
+from rich.traceback import install
+from rich.logging import RichHandler
+
+log = logging.getLogger("rich")
+console = Console()
+progress = Progress(
+    TextColumn(
+        "[progress.description]{task.description}",
+        table_column=Column(width=50),
+    ),
+    BarColumn(bar_width=None),
+    MofNCompleteColumn(table_column=Column(width=10, justify="right")),
+    console=console,
+    expand=True,
+    transient=True,
+)
+
+
+def setup_logging():
+    FORMAT = "%(message)s"
+
+    logging.basicConfig(
+        level=os.environ.get("CODE_BATTLES_LOG_LEVEL", "INFO"),
+        format=FORMAT,
+        datefmt="[%X]",
+        handlers=[RichHandler(console=console, markup=True)],
+    )
+
+    install()