Skip to content

Commit b30c6d3

Browse files
franknlifranknli
committed
DOC: update development documentation 9c823b5 
0 parents  commit b30c6d3

File tree

1,151 files changed

+203518
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,151 files changed

+203518
-0
lines changed

‎.gitignore‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/

‎.nojekyll‎

Whitespace-only changes.

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
workbench.docs.pyansys.com

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Ansys Internal
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
### ansys-workbench-core PyWorkbench Package
2+
3+
This Python package contains the public API to PyWorkbench.
4+
5+
6+
#### Installation
7+
8+
NOTE: Users must first apply the `PYANSYS_PRIVATE_PYPI_PAT` token as an environment variable. This allows authentication with Private PyPI.
9+
The value can be found at the following [link](https://dev-docs.solutions.ansys.com/solution_journey/journey_prepare/connect_to_private_pypi.html).
10+
11+
Provided that these wheels have been published to PyPI, they can be
12+
installed with:
13+
14+
Linux (bash)
15+
```bash
16+
# Create and activate a virtualenv
17+
python -m venv .venv
18+
source .venv/bin/activate # can be deactivated with the 'deactivate' command
19+
# Install pre-requisites to connect to artifact feed
20+
pip install --upgrade pip
21+
pip install keyring artifacts-keyring
22+
#Install wMI (Not Available in Private PyPI At This Time)
23+
pip install wMI==1.5.1
24+
# Install the latest package
25+
pip install --index-url https://$PYANSYS_PRIVATE_PYPI_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple ansys-workbench-core
26+
# OR - Install a package version of your choice
27+
pip install --index-url https://$PYANSYS_PRIVATE_PYPI_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple ansys-workbench-core==0.1.2
28+
```
29+
30+
Windows (PowerShell)
31+
```powershell
32+
# Create and activate a virtualenv
33+
python.exe -m venv .venv
34+
.\venv\Scripts\Activate.ps1 # can be deactivated with the 'deactivate' command
35+
# Install pre-requisites to connect to artifact feed
36+
pip.exe install --upgrade pip
37+
pip.exe install keyring artifacts-keyring
38+
#Install wMI (Not Available in Private PyPI At This Time)
39+
pip.exe install wMI==1.5.1
40+
# Install the latest package
41+
pip.exe install --index-url https://$env:PYANSYS_PRIVATE_PYPI_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple ansys-workbench-core
42+
# OR - Install a package version of your choice
43+
pip.exe install --index-url https://$env:PYANSYS_PRIVATE_PYPI_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple ansys-workbench-core==0.1.2
44+
```
45+
46+
Windows (Command Prompt)
47+
```
48+
# Create and activate a virtualenv
49+
python -m venv .venv
50+
.\venv\Scripts\activate.bat # can be deactivated with the 'deactivate' command
51+
# Install pre-requisites to connect to artifact feed
52+
pip install --upgrade pip
53+
pip install keyring artifacts-keyring
54+
#Install wMI (Not Available in Private PyPI At This Time)
55+
pip install wMI==1.5.1
56+
# Install the latest package
57+
pip install --index-url https://%PYANSYS_PRIVATE_PYPI_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple ansys-workbench-core
58+
# OR - Install a package version of your choice
59+
pip install --index-url https://%PYANSYS_PRIVATE_PYPI_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple ansys-workbench-core==0.1.2
60+
```
61+
62+
63+
#### Build
64+
65+
To build the gRPC packages, run:
66+
67+
```
68+
pip install build
69+
python -m build
70+
```
71+
72+
This will create both the source distribution containing just the protofiles
73+
along with the wheel containing the protofiles and build Python interface
74+
files.
75+
76+
Note that the interface files are identical regardless of the version of Python
77+
used to generate them, but the last pre-built wheel for ``grpcio~=1.17`` was
78+
Python 3.7, so to improve your build time, use Python 3.7 when building the
79+
wheel.
80+
81+
82+
#### Automatic Deployment
83+
84+
This repository contains GitHub CI/CD that enables the automatic building of
85+
source and wheel packages for these gRPC Python interface files. By default,
86+
these are built on PRs, the main branch, and on tags when pushing. Artifacts
87+
are uploaded to GitHub for each PR and push to the main branch. Artifacts
88+
are published to Ansys Private PyPI when tags are pushed.
89+
90+
To release wheels to PyPI, ensure your branch is up-to-date and then
91+
push tags. For example, for the version ``v0.1.5``. This version MUST MATCH
92+
the version in `pyproject.toml`.
93+
94+
For example, if you intend to release version `0.1.5` to Private PyPI, the
95+
pyproject.toml file should contain '0.1.5'. You will then run:
96+
97+
```bash
98+
git tag v0.1.5
99+
git push --tags
100+
```
101+
102+
Note that there is a 'v' prepended to the GitHub tag, keeping with best practices.
103+
The 'v' is not required in the `pyproject.toml` file.

0 commit comments

Comments
 (0)