Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added Docker support #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added Docker support #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"]
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down