You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-16Lines changed: 39 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,17 @@
1
1
### ansys-api-additive gRPC Interface Package
2
2
3
-
This Python package contains the auto-generated gRPC Python interface files for
4
-
Additive.
3
+
This package contains the gRPC interface files for the Additive
4
+
service. It is published both as a python and nuget package.
5
5
6
-
#### Installation
6
+
#### Python Installation
7
7
8
-
Provided that these wheels have been published to public PyPI, they can be
9
-
installed with:
8
+
Provided that these wheels have been published to public PyPI, they can be installed with:
10
9
11
10
```
12
11
pip install ansys-api-additive
13
12
```
14
13
15
-
#### Build
14
+
#### Python Build
16
15
17
16
To build the gRPC packages, run:
18
17
@@ -21,11 +20,9 @@ pip install build
21
20
python -m build
22
21
```
23
22
24
-
This will create both the source distribution containing just the protofiles
25
-
along with the wheel containing the protofiles and build Python interface
26
-
files.
23
+
This will create both the source distribution containing just the protofiles along with the wheel containing the protofiles and build Python interface files.
27
24
28
-
#### Manual Deployment
25
+
#### Python Manual Deployment
29
26
30
27
After building the packages, manually deploy them with:
31
28
@@ -36,15 +33,41 @@ twine upload dist/*
36
33
37
34
Note that this is automatically done through CI/CD.
38
35
36
+
#### Nuget Installation
37
+
38
+
The nuget package is called `Ansys.Api.Additive` and is published
39
+
to a repository on GitHub. To access the repository, you will
40
+
need to create a nuget source with your GitHub user credentials.
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).
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.
59
+
60
+
```
61
+
dotnet nuget push ./**/*.nupkg --source ansys
62
+
```
63
+
64
+
Note that this is automatically done through CI/CD.
65
+
39
66
#### Automatic Deployment
40
67
41
-
This repository contains GitHub CI/CD that enables the automatic building of
42
-
source and wheel packages for these gRPC Python interface files. By default,
43
-
these are built on PRs, the main branch, and on tags when pushing. Artifacts
44
-
are uploaded for each PR.
68
+
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.
45
69
46
-
To publicly release wheels to PyPI, ensure your branch is up-to-date and then
47
-
push tags. For example, for the version ``v0.5.0``.
70
+
To publicly release the packages, ensure your branch is up-to-date and then push tags. For example, for the version ``v0.5.0``.
0 commit comments