Description

<dependency>
    <groupId>org.apache.plc4x</groupId>
    <artifactId>plc4py</artifactId>
    <version>0.13.1</version>
</dependency>

<?xml version="1.0" encoding="UTF-8"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
  -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.apache.plc4x</groupId>
    <artifactId>plc4x-parent</artifactId>
    <version>0.13.1</version>
  </parent>

  <artifactId>plc4py</artifactId>
  <packaging>pom</packaging>

  <name>PLC4Py</name>
  <description>Implementation of the protocol adapters for usage as Python library.</description>

  <properties>
    <project.build.outputTimestamp>2025-08-24T18:14:38Z</project.build.outputTimestamp>
    <!-- Tell Sonar where to find the python sources -->
    <sonar.sources>plc4py</sonar.sources>
    <option.with-proxies>OFF</option.with-proxies>
  </properties>

  <build>
    <sourceDirectory>src/main/python</sourceDirectory>
    <testSourceDirectory>src/test/python</testSourceDirectory>
    <plugins>
      <!-- Unpack the protocol spec -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <executions>
          <execution>
            <id>check-dependencies</id>
            <phase>verify</phase>
            <goals>
              <goal>analyze-only</goal>
            </goals>
            <configuration>
              <failOnWarning>true</failOnWarning>
              <usedDependencies combine.children="append">
                <usedDependency>javax.annotation:jsr250-api</usedDependency>
              </usedDependencies>
            </configuration>
          </execution>
        </executions>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-remote-resources-plugin</artifactId>
        <configuration>
          <skip>true</skip>
        </configuration>
      </plugin>

      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <executions>
          <execution>
            <id>python-venv</id>
            <phase>initialize</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.exe.bin}</executable>
              <arguments>
                <argument>-m</argument>
                <argument>venv</argument>
                <argument>./venv</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-upgrade-pip</id>
            <phase>initialize</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.venv.bin}${python.exe.bin}</executable>
              <arguments>
                <argument>-m</argument>
                <argument>pip</argument>
                <argument>install</argument>
                <argument>--upgrade</argument>
                <argument>pip</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-install</id>
            <phase>initialize</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.venv.bin}pip3</executable>
              <arguments>
                <argument>install</argument>
                <argument>.</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-test-compile</id>
            <phase>process-sources</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.venv.bin}pip3</executable>
              <arguments>
                <argument>install</argument>
                <argument>.[dev]</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-black</id>
            <phase>process-sources</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.venv.bin}${python.exe.bin}</executable>
              <arguments>
                <argument>-m</argument>
                <argument>black</argument>
                <argument>.</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-dependency-check</id>
            <phase>test-compile</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.venv.bin}${python.exe.bin}</executable>
              <arguments>
                <argument>-m</argument>
                <argument>deptry</argument>
                <argument>-ddg</argument>
                <argument>dev</argument>
                <argument>.</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-test</id>
            <phase>test</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <skip>${skipTests}</skip>
              <executable>${python.venv.bin}${python.exe.bin}</executable>
              <arguments>
                <argument>-m</argument>
                <argument>pytest</argument>
                <argument>tests</argument>
              </arguments>
            </configuration>
          </execution>

          <execution>
            <id>python-package</id>
            <phase>package</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <executable>${python.venv.bin}pip3</executable>
              <arguments>
                <argument>wheel</argument>
                <argument>.</argument>
                <argument>-w</argument>
                <argument>dist</argument>
                <argument>--no-deps</argument>
              </arguments>
            </configuration>
          </execution>
        </executions>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-clean-plugin</artifactId>
        <configuration>
          <filesets>
            <fileset>
              <directory>.pytest_cache</directory>
              <followSymlinks>false</followSymlinks>
            </fileset>
            <fileset>
              <directory>build</directory>
              <followSymlinks>false</followSymlinks>
            </fileset>
            <fileset>
              <directory>dist</directory>
              <followSymlinks>false</followSymlinks>
            </fileset>
            <fileset>
              <directory>venv</directory>
              <followSymlinks>false</followSymlinks>
            </fileset>
            <fileset>
              <directory>plc4py.egg-info</directory>
              <followSymlinks>false</followSymlinks>
            </fileset>
          </filesets>
        </configuration>
      </plugin>
    </plugins>
  </build>

  <profiles>
    <profile>
      <id>update-generated-code</id>
      <build>
        <plugins>
          <plugin>
            <groupId>org.apache.plc4x.plugins</groupId>
            <artifactId>plc4x-maven-plugin</artifactId>
            <executions>
              <execution>
                <id>generate-modbus-driver</id>
                <phase>generate-sources</phase>
                <goals>
                  <goal>generate-driver</goal>
                </goals>
                <configuration>
                  <protocolName>modbus</protocolName>
                  <languageName>python</languageName>
                  <outputFlavor>read-write</outputFlavor>
                  <outputDir>${project.basedir}/plc4py/protocols</outputDir>
                </configuration>
              </execution>
              <execution>
                <id>generate-simulated-driver</id>
                <phase>generate-sources</phase>
                <goals>
                  <goal>generate-driver</goal>
                </goals>
                <configuration>
                  <protocolName>simulated</protocolName>
                  <languageName>python</languageName>
                  <outputFlavor>read-write</outputFlavor>
                  <outputDir>${project.basedir}/plc4py/protocols</outputDir>
                </configuration>
              </execution>
              <execution>
                <id>generate-umas-driver</id>
                <phase>generate-sources</phase>
                <goals>
                  <goal>generate-driver</goal>
                </goals>
                <configuration>
                  <protocolName>umas</protocolName>
                  <languageName>python</languageName>
                  <outputFlavor>read-write</outputFlavor>
                  <outputDir>${project.basedir}/plc4py/protocols</outputDir>
                </configuration>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>

      <dependencies>
        <dependency>
          <groupId>org.apache.plc4x</groupId>
          <artifactId>plc4x-code-generation-language-python</artifactId>
          <version>0.13.1</version>
          <!-- Scope is 'provided' as this way it's not shipped with the driver -->
          <scope>provided</scope>
        </dependency>

        <dependency>
          <groupId>org.apache.plc4x</groupId>
          <artifactId>plc4x-protocols-modbus</artifactId>
          <version>0.13.1</version>
          <!-- Scope is 'provided' as this way it's not shipped with the driver -->
          <scope>provided</scope>
        </dependency>

        <dependency>
          <groupId>org.apache.plc4x</groupId>
          <artifactId>plc4x-protocols-simulated</artifactId>
          <version>0.13.1</version>
          <!-- Scope is 'provided' as this way it's not shipped with the driver -->
          <scope>provided</scope>
        </dependency>

        <dependency>
          <groupId>org.apache.plc4x</groupId>
          <artifactId>plc4x-protocols-umas</artifactId>
          <version>0.13.1</version>
          <!-- Scope is 'provided' as this way it's not shipped with the driver -->
          <scope>provided</scope>
        </dependency>
      </dependencies>
    </profile>
  </profiles>

</project>