### ansys-api-additive gRPC Interface Package
This package contains the gRPC interface files for the Additive
service. It is published both as a python and nuget package.
#### Python Installation
Provided that these wheels have been published to public PyPI, they can be installed with:
```
pip install ansys-api-additive
```
#### Python 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.
#### Python 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.
#### Nuget Installation
The nuget package is called `Ansys.Api.Additive` and is published
to a repository on GitHub. To access the repository, you will
need to create a nuget source with your GitHub user credentials.
```
dotnet nuget add source --username USERNAME --password GITHUB_TOKEN --store-password-in-clear-text --name ansys "https://nuget.pkg.github.com/ansys/index.json"
```
For more information, see [GitHub Working with the NuGet registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry).
#### Nuget Build
To build the nuget package, run:
```
dotnet pack csharp/Ansys.Api.Additive.csproj -o package
```
#### Nuget Manual Deployment
Once the nuget package is built, manually deploy it with the following command. Note that this uses the same nuget source created in the Installation step.
```
dotnet nuget push ./**/*.nupkg --source ansys
```
Note that this is automatically done through CI/CD.
#### Automatic Deployment
This repository contains GitHub CI/CD that enables the automatic building of source, wheel, and nuget packages for these gRPC 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 the packages, 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
```
#### Google protobuf files
The Google third-party protobuf files were obtained from [googleapis](https://github.com/googleapis/googleapis).
Raw data
{
"_id": null,
"home_page": "https://github.com/ansys/ansys-api-additive",
"name": "ansys-api-additive",
"maintainer": "ANSYS, Inc.",
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "pyansys.core@ansys.com",
"keywords": null,
"author": "ANSYS, Inc.",
"author_email": "pyansys.core@ansys.com",
"download_url": "https://files.pythonhosted.org/packages/02/4c/2660533f854e76ba3ba2b0d109b6de0cade3c17b54e5b2f9d52c9cc44c6c/ansys_api_additive-5.1.3.tar.gz",
"platform": null,
"description": "### ansys-api-additive gRPC Interface Package\n\nThis package contains the gRPC interface files for the Additive\nservice. It is published both as a python and nuget package.\n\n#### Python Installation\n\nProvided that these wheels have been published to public PyPI, they can be installed with:\n\n```\npip install ansys-api-additive\n```\n\n#### Python Build\n\nTo build the gRPC packages, run:\n\n```\npip install build\npython -m build\n```\n\nThis will create both the source distribution containing just the protofiles along with the wheel containing the protofiles and build Python interface files.\n\n#### Python Manual Deployment\n\nAfter building the packages, manually deploy them with:\n\n```\npip install twine\ntwine upload dist/*\n```\n\nNote that this is automatically done through CI/CD.\n\n#### Nuget Installation\n\nThe nuget package is called `Ansys.Api.Additive` and is published\nto a repository on GitHub. To access the repository, you will\nneed to create a nuget source with your GitHub user credentials.\n\n```\ndotnet nuget add source --username USERNAME --password GITHUB_TOKEN --store-password-in-clear-text --name ansys \"https://nuget.pkg.github.com/ansys/index.json\"\n```\n\nFor more information, see [GitHub Working with the NuGet registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry).\n\n#### Nuget Build\n\nTo build the nuget package, run:\n\n```\ndotnet pack csharp/Ansys.Api.Additive.csproj -o package\n```\n\n#### Nuget Manual Deployment\n\nOnce the nuget package is built, manually deploy it with the following command. Note that this uses the same nuget source created in the Installation step.\n\n```\ndotnet nuget push ./**/*.nupkg --source ansys\n```\n\nNote that this is automatically done through CI/CD.\n\n#### Automatic Deployment\n\nThis repository contains GitHub CI/CD that enables the automatic building of source, wheel, and nuget packages for these gRPC interface files. By default, these are built on PRs, the main branch, and on tags when pushing. Artifacts are uploaded for each PR.\n\nTo publicly release the packages, ensure your branch is up-to-date and then push tags. For example, for the version ``v0.5.0``.\n\n```bash\ngit tag v0.5.0\ngit push --tags\n```\n\n#### Google protobuf files \n\nThe Google third-party protobuf files were obtained from [googleapis](https://github.com/googleapis/googleapis).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Autogenerated python gRPC interface package for ansys-api-additive, built on 19:12:27 on 08 September 2025",
"version": "5.1.3",
"project_urls": {
"Documentation": "https://github.com/ansys/ansys-api-additive/#readme",
"Homepage": "https://github.com/ansys/ansys-api-additive",
"Source": "https://github.com/ansys/ansys-api-additive/",
"Tracker": "https://github.com/ansys/ansys-api-additive/issues/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b161eacc0217894ca0bb69b7c6776e1cc70fd5bb3671c318a0b43f3d7f143d83",
"md5": "820407f120d3066aa76d7f5670b27763",
"sha256": "b659dc9deb9b0ad1243d8b66888b4e7c25efa9cf655deb89fee8a15a8463d6ad"
},
"downloads": -1,
"filename": "ansys_api_additive-5.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "820407f120d3066aa76d7f5670b27763",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 111375,
"upload_time": "2025-09-08T19:12:47",
"upload_time_iso_8601": "2025-09-08T19:12:47.787175Z",
"url": "https://files.pythonhosted.org/packages/b1/61/eacc0217894ca0bb69b7c6776e1cc70fd5bb3671c318a0b43f3d7f143d83/ansys_api_additive-5.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "024c2660533f854e76ba3ba2b0d109b6de0cade3c17b54e5b2f9d52c9cc44c6c",
"md5": "c3fcf5f4c4710a437badf74669877dd1",
"sha256": "6cb38802593d7d606120c5260df1d87e316a4ccdc2727450b8ca474a6db34a33"
},
"downloads": -1,
"filename": "ansys_api_additive-5.1.3.tar.gz",
"has_sig": false,
"md5_digest": "c3fcf5f4c4710a437badf74669877dd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 28462,
"upload_time": "2025-09-08T19:12:49",
"upload_time_iso_8601": "2025-09-08T19:12:49.680800Z",
"url": "https://files.pythonhosted.org/packages/02/4c/2660533f854e76ba3ba2b0d109b6de0cade3c17b54e5b2f9d52c9cc44c6c/ansys_api_additive-5.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-08 19:12:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "ansys-api-additive",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ansys-api-additive"
}
JSON
