colcon-python-project-example

An example of a workspace and packages for colcon-python-project. For more information, see the Call For Testing: Standards-based Python packaging with colcon.

This repository aims to implement minimum examples the following scenarios listed below.

Description	Status
Standalone packages utilizing pytest and unittest	Minimal setuptools implementation, PEP 517 implementation for standalone pytest package available with some TODOs
Inter package dependencies	Minimal setuptools implementation, PEP 517 implementation missing
Providing pytest plugins and fixtures across packages	Minimal setuptools implementation, PEP 517 implementation missing
Providing python source trees for other packages	Implemented but not explicit tests

The packages should be able to be built with merge and symlink installs, as well as regular builds and work with PEP 517.

Install colcon-python-project

In order to get started with colcon-python-project run the following commands to checkout its repository and install its dependencies:

git clone https://github.com/colcon/colcon-python-project.git -b devel src/colcon-python-project
sudo apt-get install -y python3-tomli python3-pytest-cov python3-pytest-benchmark python3-pep8-naming python3-poetry pylint 
pip install scspell3k

Build the workspace and source it:

colcon build
. /install/local_setup.bash

Verify the installation. The extension is active if you see python.project and ros.ament_python.project packages:

colcon list