Overview
What is py-poetry?
A template that has Python configured for VS Code with Poetry, and includes an agent script and CodeQL integration via Docker.
How to use py-poetry?
Run the agent using python src/agent.py <path_to_local_git_repo>. For CodeQL analysis, build the Docker container, then use CodeQL CLI commands against the container's file system.
Key features of py-poetry
- Python project configured for VS Code with Poetry.
- Includes an agent script for local git repositories.
- Supports CodeQL analysis via generated Docker container.
- Provides Dockerfile and docker-compose.yml files.
Use cases of py-poetry
- Setting up a Python development environment with Poetry and VS Code.
- Running CodeQL security queries on Python code inside a Docker container.
- Automating local git repository analysis with the agent script.
FAQ from py-poetry
What is py-poetry?
A template that configures Python for VS Code using Poetry, and includes an agent and CodeQL support.
How do I run the agent?
Use the command python src/agent.py <path_to_local_git_repo>, replacing the placeholder with your repository path.
How do I use CodeQL with py-poetry?
Build the Docker container, then run CodeQL database creation and analysis commands (e.g., codeql database create and codeql database analyze) against the container's workspace.
What files are provided?
The template includes a Dockerfile, docker-compose.yml, and a codeql-config.yml file (generated in the container root).
Does py-poetry have any dependencies?
It requires Python, Poetry, VS Code, Docker, and CodeQL CLI to use all features.
