xref: /aosp_15_r20/external/pigweed/pw_env_setup/sample_project_action/__init__.py (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1# Copyright 2023 The Pigweed Authors
2#
3# Licensed under the Apache License, Version 2.0 (the "License"); you may not
4# use this file except in compliance with the License. You may obtain a copy of
5# the License at
6#
7#     https://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12# License for the specific language governing permissions and limitations under
13# the License.
14"""Sample pw_env_setup project action plugin.
15
16A sample/starter project action plugin template for pw_env_setup.
17"""
18
19
20def run_action(**kwargs):
21    """Sample project action."""
22    if "env" not in kwargs:
23        raise ValueError(f"Missing required kwarg 'env', got %{kwargs}")
24
25    kwargs["env"].prepend("PATH", "PATH_TO_NEW_TOOLS")
26    raise NotImplementedError("Sample project action running!")
27