How-to

This section describes several guidelines and best practices for creating effective and efficient Python libraries to interface with Ansys products and services. Topics also demonstrate how apps and complex services expose functionalities such as logging, data transfer, and app APIs.

• Setting up your development environment
  • Python
    • Installation
    • Verification
  • Virtual environments
    • Check
    • Create
    • Activate
    • Deactivate
  • Git
    • Installation
    • Verification
    • Usage
    • Configuration
    • Signing commits
    • Enabling SSH
    • Handling line endings
  • WSL2
    • Installation
    • Verification
    • Linux distribution
  • Windows terminal
    • Installation
• Supporting Python versions
  • Verifying support
• Contributing
  • Create a GitHub account
  • GitHub repository sections
  • Create an issue
    • Request new features
    • Report bugs
  • Fork a repository
  • Clone a repository
    • Clone using SSH
  • Install in editable mode
  • Create a branch
    • Branch naming conventions
  • Push a new branch
  • Create a pull request
  • Use GitHub CLI
• Packaging
  • Specifying dependencies
    • Required dependencies
    • Optional dependencies
  • Dependabot
    • The dependabot.yml file
    • Dependabot updates
    • Dependabot version updates
    • Dependabot security updates
• gRPC API packages
  • Maintain API definition repository
  • Managing Protobuf definitions for Python clients
    • How to build an ansys-api-<service> repository
    • Building Python stub classes
    • Publishing Python API package
    • Consuming the API package within Python
    • Using the API package within the Python client
    • Public vs private Python API package
• Logging
  • Description and usage
  • Logging best practices
    • Avoiding printing to the console
    • Turning on and off handlers
    • Using app filters
    • Use %-formatting for strings
  • App and service logging modules
  • Global logger
  • Instance logger
  • Ansys product loggers
  • Custom log handlers
• Documenting
  • Documentation sources
    • Docstrings
    • RST files
    • Examples
  • Document Python code
    • Document classes
  • Build documentation
    • Build HTML documentation
    • Build PDF documentation
  • Enabling multi-version documentation
  • Deploying documentation
    • Deploying to another repository
  • Access online documentation
• Testing
  • Test framework
    • Add testing dependencies
    • Organize test files
  • Run tests
    • Filter tests
  • Testing methodology
    • Unit testing
    • Integration testing
    • Functional testing
  • Test code coverage
    • Configure code coverage
    • Enforce code coverage
  • Test using GitHub Actions
• Using continuous integration
  • Enable GitHub actions
  • Use GitHub actions
  • Disable concurrent workflows
  • Required workflows
  • Parametrize workflows
  • Workflow examples
• Releasing and publishing
  • Semantic versioning
  • Branch model
  • Releasing new versions
  • Publishing artifacts
    • Private PyPI
    • Public PyPI
    • GitHub
  • Downloading artifacts
• Repository protection
  • General configuration
  • Branch protection
  • Tag protection
  • Workflow protection
• DNS configuration
  • DNS TXT verification
  • PyAnsys verified domains
  • DNS protection measures
    • Case scenario - protected subdomain
    • Case scenario - vulnerable subdomain
  • Preventing CNAME takeover
• Ansys product compatibility
  • check_version.py module approach
    • version_requires decorator