Feat: codegen service (#2)

Author: thekaveman

.devcontainer/Dockerfile

@@ -5,6 +5,9 @@ ENV PYTHONDONTWRITEBYTECODE=1 \
     USER=compiler
 
 RUN useradd --create-home --shell /bin/bash $USER && \
+    mkdir /toggl_py && \
+    mkdir -p /home/$USER/.local/bin && \
+    chown -R $USER /toggl_py && \
     chown -R $USER /home/$USER
 
 RUN apt update && \
@@ -14,13 +17,18 @@ RUN apt update && \
     apt install -y python3.11 python3-pip && \
     ln -s /usr/bin/python3.11 /usr/bin/python
 
-RUN wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.19/swagger-codegen-cli-2.4.19.jar -O /home/$USER/swagger-codegen-cli.jar
-
 USER $USER
-ENV PATH "$PATH:/usr/bin:/home/$USER/.local/bin"
+
+RUN wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.19/swagger-codegen-cli-2.4.19.jar \
+        -O /home/$USER/.local/bin/swagger-codegen-cli.jar
+
+ENV PATH "/home/$USER/.local/bin:$PATH"
 WORKDIR /home/$USER/toggl-py
 
 RUN python -m pip install --upgrade pip && \
     pip install black pre-commit
 
+COPY LICENSE LICENSE
+COPY codegen/ codegen/
+
 CMD ["sleep", "infinity"]

.devcontainer/devcontainer.json

@@ -5,6 +5,7 @@
   "service": "dev",
   "runServices": ["dev"],
   "workspaceFolder": "/home/compiler/toggl-py",
+  "postAttachCommand": ["/bin/bash", ".devcontainer/postAttach.sh"],
   "customizations": {
     "vscode": {
       // Set *default* container specific settings.json values on container create.

.devcontainer/postAttach.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -eux
+
+pip install -e toggl_py/

.env.sample

@@ -0,0 +1,4 @@
+CODEGEN_DIR=codegen
+CODEGEN_JAR=/home/compiler/.local/bin/swagger-codegen-cli.jar
+CODEGEN_LANG=TogglPythonClientCodegen
+CODEGEN_TARGET=/toggl_py

.gitignore

@@ -1,5 +1,6 @@
 *.egg-info
 .classpath
+.env
 .project
 .settings/
 target/

README.md

@@ -1,4 +1,12 @@
 # `toggl-py`
 
-Python implementation of the Toggl API, autogenerated from their
+Python implementation of the Toggl API v9, autogenerated from their
 [OpenAPI (Swagger) specification](https://engineering.toggl.com/docs/openapi).
+
+## [`codegen`](./codegen/)
+
+This directory contains a [custom Swagger codegen module](https://github.com/swagger-api/swagger-codegen?tab=readme-ov-file#making-your-own-codegen-modules) for generating the `toggl-py` package.
+
+## [`toggl_py`](./toggl_py/)
+
+This directory contains the generated Python library and docs.

codegen/README.md

@@ -1,34 +1,63 @@
-# `toggl-py` codegen
+# toggl-py codegen
 
 This folder contains configuration and scripts for generating the `toggl-py` source from
 [Toggl's OpenApi (Swagger) spec](./spec.json).
 
-Code generation uses the Docker image wrapping [`swagger-codegen`](https://github.com/swagger-api/swagger-codegen.git).
+Code generation uses a custom Docker image wrapping the
+[`swagger-codegen-cli`](https://github.com/swagger-api/swagger-codegen.git).
+
+## Setup
+
+From the root of this repository
+
+1. Create an environment file from the sample (defaults are good for now)
+
+   ```bash
+   cp .env.sample .env
+   ```
+
+2. Then build the main Docker image:
+
+   ```bash
+   docker compose build
+   ```
+
+## Open a devcontainer
+
+Open this repository in VS Code, then `Rebuild and Reopen in Container`.
 
 ## Generate the code
 
-From the root of this repository, run the generate script:
+(Outside a devcontainer), run the Docker Compose `codegen` service:
 
 ```bash
-codegen/bin/run.sh
+docker compose run codegen
 ```
 
-_Requires Docker_
+(Inside the devcontainer), run the codegen script directly:
+
+```bash
+codegen/bin/run.sh
+```
 
 ## Edit configuration
 
 Some configuration values can be changed in [`config.json`](./config.json).
 
 Other flags for `swagger-codegen` can be modified in the [`run.sh`](./bin/run.sh) script.
 
-Use the [`help.sh`](./bin/help.sh) script to find out more about `swagger-codegen` configuration options:
+Use the [`help.sh`](./bin/help.sh) script to find out more about `swagger-codegen-cli` configuration options:
 
 ```bash
 codegen/bin/help.sh
 ```
 
-_Requires Docker_
-
 ## Edit templates
 
-The [`templates`](./templates/) directory contains [Mustache](https://mustache.github.io/) templates for the generated files.
+Custom [Mustache](https://mustache.github.io/) templates used to generate the files live under [`./TogglPythonClientCodegen/src/main/resources/TogglPythonClientCodegen/`](./TogglPythonClientCodegen/src/main/resources/TogglPythonClientCodegen/).
+
+## Edit the generator class
+
+[`TogglPythonClientCodegen`](./TogglPythonClientCodegen/src/main/java/la/compiler/codegen/TogglPythonClientCodegen.java) is the
+custom Java class, inheriting from and overriding some behavior of Swagger's [`PythonClientCodegen`](https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PythonClientCodegen.java),
+serving as the "language" implementation that `swagger-codegen-cli` uses to generate `toggl-py`.

codegen/TogglPythonClientCodegen/src/main/resources/TogglPythonClientCodegen/partial_header.mustache

@@ -7,6 +7,5 @@ This file is auto generated by the swagger code generator program.
 Do not edit this file manually.
 
 {{#version}}OpenAPI spec version: {{{version}}}{{/version}}
-Last changed: {{generatedDate}}
-Generated by: https://github.com/compilerla/toggl-py/tree/main/codegen
+Generated by: https://github.com/compilerla/toggl-py
 """

codegen/bin/help.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
 set -eux
 
-java -cp ~/swagger-codegen-cli.jar:codegen/TogglPythonClientCodegen/target/* io.swagger.codegen.SwaggerCodegen help generate
-java -cp ~/swagger-codegen-cli.jar:codegen/TogglPythonClientCodegen/target/* io.swagger.codegen.SwaggerCodegen config-help -l TogglPythonClientCodegen
+java -cp $CODEGEN_JAR:$CODEGEN_DIR/$CODEGEN_LANG/target/* io.swagger.codegen.SwaggerCodegen help generate
+java -cp $CODEGEN_JAR:$CODEGEN_DIR/$CODEGEN_LANG/target/* io.swagger.codegen.SwaggerCodegen config-help -l $CODEGEN_LANG

codegen/bin/meta.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 set -eux
 
-docker run --rm -u 1000:1000 -v ${PWD}:/dist -w /dist swaggerapi/swagger-codegen-cli meta \
-    --name TogglPythonClientCodegen \
-    --output codegen/TogglPythonClientCodegen \
+java -jar $CODEGEN_JAR meta \
+    --name $CODEGEN_LANG \
+    --output $CODEGEN_DIR/$CODEGEN_LANG \
     --package la.compiler.codegen