Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xeden3/docker-excel-macro-run
This is a Docker container that runs Excel macros using Python win32 on a Wine and Office environment.
https://github.com/xeden3/docker-excel-macro-run
docker excel office python vba win32com wine
Last synced: 29 days ago
JSON representation
This is a Docker container that runs Excel macros using Python win32 on a Wine and Office environment.
- Host: GitHub
- URL: https://github.com/xeden3/docker-excel-macro-run
- Owner: xeden3
- Created: 2024-05-08T16:41:55.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-09T03:15:23.000Z (9 months ago)
- Last Synced: 2024-11-19T10:57:10.411Z (3 months ago)
- Topics: docker, excel, office, python, vba, win32com, wine
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Excel Macro Runner Docker (docker-excel-macro-run)
This Docker container provides a solution to run Excel macros using Python win32 on a Wine and Office environment. It supports installation via GitHub and Docker Hub. Below are the steps for installation and usage.
### Installation
#### GitHub Installation
1. Clone the repository:
```bash
git clone https://github.com/xeden3/docker-excel-macro-run.git
cd docker-excel-macro-run
```
2. Build the Docker image:
```bash
docker build -t docker-excel-macro-run:v1 .
```
#### Docker Hub Installation
Pull the Docker image directly from Docker Hub:
```bash
docker pull xeden3/docker-excel-macro-run:v1
```
### Usage
Run the Docker container with the following command:
```bash
docker run -v ./example.xlsm:/opt/wineprefix/drive_c/test.xlsm --rm docker-excel-macro-run:v1 test.xlsm ThisWorkbook.WriteDataToSheet1
```
The parameters explained:
- `docker-excel-macro-run:v1`: Docker image name and tag.
- `test.xlsm`: Name of the Excel file to run the macro on. It should match the filename in the container's directory (`/opt/wineprefix/drive_c/test.xlsm`).
- `ThisWorkbook.WriteDataToSheet1`: Macro command to execute.
The output will be in JSON format:
```json
{"errcode": 0, "errmsg": ""}
```
You can retrieve and print the output using:
```bash
output=$(docker run -v ./example.xlsm:/opt/wineprefix/drive_c/test.xlsm --rm docker-excel-macro-run:v1 test.xlsm ThisWorkbook.WriteDataToSheet1)
echo $output
```
### Challenges
This Docker container addresses two main challenges:
1. **Handling Errors with Chinese Programs**: Chinese characters are not recognized in the default Wine environment. Therefore, when macros contain Chinese or other languages, errors may occur. Installing the appropriate font library and changing the `locales` value can resolve this issue.
To address this in Docker, the following steps are taken:
```Dockerfile
RUN apt-get update && apt-get install -y locales
RUN sed -i -e 's/# zh_CN.UTF-8 UTF-8/zh_CN.UTF-8 UTF-8/' /etc/locale.gen && \
dpkg-reconfigure --frontend=noninteractive locales && \
update-locale LANG=zh_CN.UTF-8
ENV LC_ALL=zh_CN.UTF-8
```
### Challenges (Continued)
This Docker container also addresses another significant challenge:
2. **Suppressing xvfb-run Output**: During program execution, `xvfb-run` may output the following warning:
```
X connection to :100 broken (explicit kill or server shutdown).
```
To mitigate this, an `entrypoint.sh` file is added. This shell script filters out the warning message using the `grep` command. Failure to suppress this warning may result in numerous exception messages being returned.
Below is the code snippet used to suppress the warning:
```bash
# Disable the 'X connection to :100 broken (explicit kill or server shutdown).' warning
xvfb-run -a wine python /opt/wineprefix/drive_c/app/excel_xlsm_macro_run.py "$@" | grep -v '100 broken'
```
This command ensures that the warning message is filtered out from the output, providing a cleaner execution result.