https://github.com/ansys/ansys-api-dbu
Protofiles for common purposes on Ansys DBU
https://github.com/ansys/ansys-api-dbu
Last synced: 3 months ago
JSON representation
Protofiles for common purposes on Ansys DBU
- Host: GitHub
- URL: https://github.com/ansys/ansys-api-dbu
- Owner: ansys
- License: mit
- Created: 2023-07-31T07:44:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-02T11:52:40.000Z (11 months ago)
- Last Synced: 2024-08-01T11:58:31.099Z (10 months ago)
- Language: Python
- Size: 51.8 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
### ansys-api-dbu gRPC Interface Package
This repository provides the auto-generated gRPC Python interface files for
the Ansys DBU Service.
#### Installation
Provided that these wheels have been published to public PyPI, they can be
installed with:
```
pip install ansys-api-dbu
```
#### 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.
#### 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
```