diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..c5c39cd --- /dev/null +++ b/Dockerfile @@ -0,0 +1,7 @@ +FROM amancevice/pandas:1.0.5-alpine + +RUN apk add --update --no-cache grep ctags libstdc++ + +RUN pip3 install functiondefextractor + +ENTRYPOINT [ "python", "-m", "functiondefextractor", "--p", "/usr/bin/code"] \ No newline at end of file diff --git a/README.md b/README.md index 0b21554..ff9783a 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,18 @@ Advantage of using such function extractions are, pip install functiondefextractor ``` +## Run in Docker + +There is a Dockerfile, which can be used to run the application. First build the image: +```sh +docker build --tag=functiondefextractor:latest . +``` + +Then execute the container. This assumes the repo you want to scan is the current working directory (xls files will be generated in the mounted folder) +```sh +docker run -it --rm --name functiondefextractor -v ${PWD}/:/usr/bin/code --platform=linux/amd64 functiondefextractor:latest +``` + ## Usage & Configuration ### Code