py-poetry logo

py-poetry

by Tyler-R-Kendrick

A template configured for Python development in VS Code using Poetry. It includes instructions for running an agent and using CodeQL.

View on GitHub

Last updated: N/A

What is py-poetry?

A Python project template configured for development in VS Code with Poetry for dependency management. It also provides instructions for integrating CodeQL for security analysis.

How to use py-poetry?

  1. Run the agent using python src/agent.py <path_to_local_git_repo>. 2. To use CodeQL, ensure codeql-config.yml is generated. 3. Build and run the Docker container. 4. Use CodeQL CLI to analyze Python files within the container, creating a database and running queries.

Key features of py-poetry

  • Python development environment

  • Poetry dependency management

  • VS Code configuration

  • Docker integration

  • CodeQL integration

Use cases of py-poetry

  • Setting up a new Python project

  • Managing dependencies with Poetry

  • Developing in VS Code

  • Containerizing Python applications

  • Performing security analysis with CodeQL

FAQ from py-poetry

How do I run the agent?

Use the command python src/agent.py <path_to_local_git_repo>, replacing <path_to_local_git_repo> with the path to your local git repository.

What is the purpose of the codeql-config.yml file?

It configures CodeQL for analyzing the project.

How do I build the Docker container?

Use the provided Dockerfile and docker-compose.yml files.

How do I run CodeQL queries?

Use the CodeQL CLI to create a database and run queries against the Python files in the container. See the example command in the README.

What is Poetry?

Poetry is a tool for dependency management and packaging in Python.