code-battles-cli 0.1.1__tar.gz → 1.0.0__tar.gz

{code_battles_cli-0.1.1 → code_battles_cli-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: code-battles-cli
-Version: 0.1.1
+Version: 1.0.0
 Summary: A CLI for competitors in any Code Battles event!
 License-File: LICENSE.md
 Requires-Python: >=3.8
@@ -16,6 +16,7 @@ Description-Content-Type: text/markdown
 <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>
@@ -34,7 +35,7 @@ Description-Content-Type: text/markdown
 # 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`.
+-   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.
@@ -51,7 +52,13 @@ You can update a bot in the website by running `code-battles upload bots/example
 
 If you want to choose a custom bot name, you can run `code-battles upload bots/example.py -n myamazingbot`.
 
-## Usage in Scripts
+## 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!
 
@@ -63,6 +70,7 @@ 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

{code_battles_cli-0.1.1 → code_battles_cli-1.0.0}/README.md

@@ -4,6 +4,7 @@
 <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>
@@ -22,7 +23,7 @@
 # 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`.
+-   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.
@@ -39,7 +40,13 @@ You can update a bot in the website by running `code-battles upload bots/example
 
 If you want to choose a custom bot name, you can run `code-battles upload bots/example.py -n myamazingbot`.
 
-## Usage in Scripts
+## 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!
 
@@ -51,6 +58,7 @@ 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

{code_battles_cli-0.1.1 → code_battles_cli-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "code-battles-cli"
-version = "0.1.1"
+version = "1.0.0"
 description = "A CLI for competitors in any Code Battles event!"
 dependencies = [
     "requests>=2.32.3",

{code_battles_cli-0.1.1 → code_battles_cli-1.0.0}/src/code_battles_cli/api.py

@@ -6,13 +6,33 @@ Firestore client implementation inspired by https://medium.com/@bobthomas295/cli
 
 import os
 import json
-from typing import Dict, List, Optional
+import shutil
+import subprocess
+import sys
+from typing import 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.logging import console, log
+from code_battles_cli.log import console, log
+
+
+@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]
 
 
 class Client:
@@ -117,6 +137,79 @@ class Client:
     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.
+        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 run_simulation(
+        self,
+        map: str,
+        bot_filenames: List[str],
+        bot_names: Optional[List[str]] = None,
+        force_download=False,
+        json_output=False,
+    ) -> 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 = 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)
+
+            pyscript_configuration = requests.get(self.url + "/config.json").json()
+
+            for url_path, path in pyscript_configuration["files"].items():
+                local_path = os.path.join(
+                    code_directory, *path.replace(".pyi", ".py").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)
+
+        p = subprocess.Popen(
+            [
+                sys.executable,
+                os.path.join(code_directory, "main.py"),
+                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,
+        )
+        p.wait()
+        output = p.stdout.read().split(b"--- SIMULATION FINISHED ---")[-1]
+        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"]
+            ],
+        )

{code_battles_cli-0.1.1 → code_battles_cli-1.0.0}/src/code_battles_cli/cli.py

@@ -9,15 +9,17 @@ def cli():
 
 
 def main() -> int:
-    from code_battles_cli.logging import setup_logging, log
+    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-0.1.1 → code_battles_cli-1.0.0}/src/code_battles_cli/commands/download.py

@@ -4,7 +4,7 @@ from typing import Optional
 import click
 
 from code_battles_cli.api import Client
-from code_battles_cli.logging import log
+from code_battles_cli.log import log
 
 
 @click.command()

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

@@ -0,0 +1,46 @@
+import time
+import logging
+from typing import List, Optional, Tuple
+
+import click
+
+from code_battles_cli.api import Client
+from code_battles_cli.log import log
+
+
+@click.command()
+@click.argument("map")
+@click.argument("bots", nargs=-1)
+@click.option(
+    "-U", "--url", help="The competitions 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",
+    default=True,
+    show_default=True,
+    help="Dump the URL, username and password to a `code-battles.json` file",
+)
+@click.option(
+    "--force-download",
+    default=False,
+    show_default=True,
+    help="Re-downloads the simulation code from the website",
+)
+def run(
+    url: Optional[str],
+    username: Optional[str],
+    password: Optional[str],
+    dump_credentials: bool,
+    map: str,
+    bots: Tuple[str],
+    force_download: bool,
+):
+    logging.getLogger("rich").setLevel(logging.WARNING)
+    client = Client(url, username, password, dump_credentials)
+    start = time.time()
+    results = client.run_simulation(map, list(bots), force_download=force_download)
+    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-0.1.1 → code_battles_cli-1.0.0}/src/code_battles_cli/commands/upload.py

@@ -4,7 +4,7 @@ from typing import Optional
 import click
 
 from code_battles_cli.api import Client
-from code_battles_cli.logging import log
+from code_battles_cli.log import log
 
 
 @click.command()