How-to#
This section describes how to create effective and efficient Python libraries for interfacing with Ansys products and services. It also explains how apps and complex services expose functionalities such as logging, data transfer, and app APIs.
Prerequisites
How to configure your Python environment before contributing to a PyAnsys project.
How to follow PyAnsys coding standards, branching, and the contribution workflow.
Library Development
How to define which Python versions your library supports and configure CI accordingly.
How to package and distribute a PyAnsys library for end users.
How to structure gRPC API packages following PyAnsys conventions.
How to add structured logging to a PyAnsys library.
How to write and maintain documentation following PyAnsys style guidelines.
Quality Assurance
How to write unit and integration tests and measure code coverage.
How to automate testing, linting, and builds with GitHub Actions.
Security and Maintenance
How to secure branches, tags, and secrets in your GitHub repository.
How to find and fix security vulnerabilities in a PyAnsys package.
How to manage compatibility across different Ansys product versions.
How to retire a library cleanly and guide users to alternatives.
Release & Publish
How to set up the documentation domain for your PyAnsys library.
How to create and publish a versioned release to PyPI.