The ansys-templates repository holds a collection of useful templates compliant with PyAnsys guidelines. It also provides the ansys-templates command line tool for interactively generating new projects based on previous templates.
The main advantages of using this tool are:
Building process is fully interactive. There is no need to manually modify files.
Output of the project can easily be customized during the rendering process.
Generated projects are compliant with PyAnsys Developer’s Guidelines.
For information on using this tool, see the Ansys Templates Documentation.
How to install
Users can install ansys-templates by running:
python -m pip install ansys-templatesThe usage of pipx is encouraged too. See installing ansys-templates using pipx.
Basic commands
The following commands are provided with ansys-templates:
ansys-templates --help: lists information about the tool.
ansys-templates list: lists all available templates.
ansys-templates new <template name>: creates a new project from template.
Available templates
Available templates in ansys-templates are:
doc-project: Create a documentation project using Sphinx.
pybasic: Create a basic Python Package.
pyansys: Create a PyAnsys Python Package project.
pyansys-advanced: Create an advanced PyAnsys Python Package project.
pyansys-openapi-client: Create an OpenAPI Client Package project.
pyace: Create a Python project for any method developers.
pyace-flask: Create a Flask project initialized for any developer.
pyace-grpc: Create gRPC project initialized for any developer.
pyace-fast: Create a FastAPI project initialized for any developer.
solution: Create a Solution based on the Solution Application Framework. For Ansys Internal Use Only
Template features
The following table summarizes the main properties for each of the templates available in ansys-templates:
Template |
setup.py |
pyproject.toml |
Actions |
tox.ini |
requirements/ |
Docker |
|---|---|---|---|---|---|---|
doc-project |
X |
X |
X |
|||
pybasic |
X |
|||||
pyansys |
X |
X |
X |
|||
pyansys-advanced |
X |
X |
X |
X |
X |
|
pyansys-openapi-client |
||||||
pyace |
X |
X |
X |
X |
X |
X |
pyace-fast |
X |
X |
X |
X |
X |
X |
pyace-flask |
X |
X |
X |
X |
X |
X |
pyace-grpc |
X |
X |
X |
X |
X |
X |
solution “*” |
X |
X |
X |
X |
Demo branches
To have a better idea on how each template will look once it gets rendered, see its corresponding demonstration branch.
Demo branch for doc-project
Demo branch for pybasic
Demo branch for pyansys
Demo branch for pyansys-advanced using flit
Demo branch for pyansys-advanced using poetry
Demo branch for pyansys-advanced using setuptools
Demo branch for pyace
Demo branch for pyace-fast
Demo branch for pyace-flask
Demo branch for pyace-grpc
Demo branch for solution
1 maintainer
Metadata
1 maintainer
Release files for ansys-templates 5.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ansys_templates-5.1.0.tar.gz | 2.0 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ansys_templates-5.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.1 MB
Release files / ansys_templates-5.1.0.tar.gz
| Download URL | ansys_templates-5.1.0.tar.gz |
|---|---|
| Size | 2.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9e0ff29fba4211d76b22081a3c2e52456d29b1d70aecef80126c85ee83204e71
|
|
BLAKE2b-256 checksum How to use checksums |
a6e7e3d45d35c71f056cb44ea645a41d335388117725062ead405d8f5805dab6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.12
|
Release files / ansys_templates-5.1.0-py3-none-any.whl
| Download URL | ansys_templates-5.1.0-py3-none-any.whl |
|---|---|
| Size | 2.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce872a7652a99c293da2ce30743366d9f739fd8ff576ffa74e9e774011c8d972
|
|
BLAKE2b-256 checksum How to use checksums |
0d36a65c93c31680ce9cbfb8875dd0089b0c121860940f05ce638272c43b9793
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.12
|
Security for ansys-templates 5.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
