Skip to content

Commit 059d775

Browse files
Add disclaimer while project is private (#188)
Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>
1 parent 750ed35 commit 059d775

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,21 @@ Then, you can simply execute:
9595
9696
poetry run python -m pip install ansys-geometry-core
9797
98-
98+
.. caution::
99+
100+
PyGeometry is currently hosted in a private PyPi repository. You must provide the index
101+
URL to the private PyPi repository:
102+
103+
* Index URL: ``https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/``
104+
105+
If you don't have access to this package registry, email `pyansys.support@ansys.com <mailto:pyansys.support@ansys.com>`_
106+
to request access. We will provide you a read-only token to be inserted in ``${PRIVATE_PYPI_ACCESS_TOKEN}``.
107+
Once you have it, run the following command:
108+
109+
.. code:: bash
110+
111+
pip install ansys-geometry-core --index-url=https://${PRIVATE_PYPI_ACCESS_TOKEN}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/
112+
99113
For developers
100114
^^^^^^^^^^^^^^
101115

0 commit comments

Comments
 (0)