Skip to content

Update documentation to reflect API changes #2439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TheJanzap wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update documentation to reflect API changes #2439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44cc5af
Add `Runtime.PythonDLL` to C# example in README
TheJanzap Aug 22, 2024
2f69bd3
doc: Add different methods to reference Python DLL
TheJanzap Aug 22, 2024
243dace
doc: Create separate bullet point for Python DLL
TheJanzap Aug 27, 2024
353bb26
README: Add comment about setting Python DLL to example
TheJanzap Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ Example

static void Main(string[] args)
{
// The Python library can also be set with the `PYTHONNET_PYDLL` env var
// or dynamically with a library like https://github.com/losttech/WhichPython
Runtime.PythonDLL = "python38.dll";
Copy link
Member

@filmor filmor Aug 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really don't want to give people the idea that this is the way to go. Maybe we can point them toward (or include) https://github.com/losttech/WhichPython? Maybe give a note above to set the PYTHONNET_PYDLL environment variable?

Copy link
Author

@TheJanzap TheJanzap Aug 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I wasn't really keen on this either, but I figured since this was one of the examples given in the paragraph above it that this would be at least acceptable.
I also thought about mentioning the env var, but I didn't want to clutter this example with a comment (at least not without the permisson of you guys)

PythonEngine.Initialize();
using (Py.GIL())
{
Expand Down
2 changes: 2 additions & 0 deletions doc/source/dotnet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ At a very high level, to embed Python in your application one will need
to:

- Reference ``Python.Runtime.dll`` (e.g. via a ``PackageReference``)
- Set the Python library the code should run with via the ``Runtime.PythonDLL``
property or the ``PYTHONNET_PYDLL`` environment variable
- Call ``PythonEngine.Initialize()`` to initialize Python
- Call ``var mod = PyModule.Import(name)`` to import a module as ``mod``

Expand Down