https://github.com/ansys/ansys-api-mechanical
https://github.com/ansys/ansys-api-mechanical
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ansys/ansys-api-mechanical
- Owner: ansys
- License: mit
- Created: 2023-02-28T14:27:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T14:20:43.000Z (about 1 year ago)
- Last Synced: 2025-04-13T01:32:00.590Z (about 1 month ago)
- Language: Python
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### ansys-api-mechanical gRPC Interface Package
This Python package contains the auto-generated gRPC Python interface files for
Mechanical.
#### Installation
Provided that these wheels have been published to public PyPI, they can be
installed with:
```
pip install ansys-api-mechanical
```
Otherwise, see the
#### Build
To build the gRPC packages, run:
```
pip install build
python -m build
```
This will create both the source distribution containing just the protofiles
along with the wheel containing the protofiles and build Python interface
files.
Note that the interface files are identical regardless of the version of Python
used to generate them, but the last pre-built wheel for ``grpcio~=1.30`` was
Python 3.7, so to improve your build time, use Python 3.7 when building the
wheel.
#### Manual Deployment
After building the packages, manually deploy them with:
```
pip install twine
twine upload dist/*
```
Note that this is automatically done through CI/CD.
#### Automatic Deployment
This repository contains GitHub CI/CD that enables the automatic building of
source and wheel packages for these gRPC Python interface files. By default,
these are built on PRs, the main branch, and on tags when pushing. Artifacts
are uploaded for each PR.
To publicly release wheels to PyPI, ensure your branch is up-to-date and then
push tags. For example, for the version ``v0.5.0``.
```bash
git tag v0.5.0
git push --tags
```