- Notifications
You must be signed in to change notification settings - Fork750
Include README.md into NuGet package#1599
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 2 additions & 0 deletionssrc/runtime/Python.Runtime.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletionssrc/runtime/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
`pythonnet` is a package that gives .NET programmers ability to | ||
integrate Python engine and use Python libraries. | ||
## Embedding Python in .NET | ||
- You must set `Runtime.PythonDLL` property or `PYTHONNET_PYDLL` environment variable, | ||
otherwise you will receive `BadPythonDllException` | ||
(internal, derived from `MissingMethodException`) upon calling `Initialize`. | ||
Typical values are `python38.dll` (Windows), `libpython3.8.dylib` (Mac), | ||
`libpython3.8.so` (most other *nix). Full path may be required. | ||
- All calls to Python should be inside a | ||
`using (Py.GIL()) {/* Your code here */}` block. | ||
- Import python modules using `dynamic mod = Py.Import("mod")`, then | ||
you can call functions as normal, eg `mod.func(args)`. | ||
You can also access Python objects via `PyObject` and dervied types | ||
instead of using `dynamic`. | ||
- Use `mod.func(args, Py.kw("keywordargname", keywordargvalue))` or | ||
`mod.func(args, keywordargname: keywordargvalue)` to apply keyword | ||
arguments. | ||
- Mathematical operations involving python and literal/managed types | ||
must have the python object first, eg. `np.pi * 2` works, | ||
`2 * np.pi` doesn't. | ||
## Example | ||
```csharp | ||
using var _ = Py.GIL(); | ||
dynamic np = Py.Import("numpy"); | ||
Console.WriteLine(np.cos(np.pi * 2)); | ||
dynamic sin = np.sin; | ||
Console.WriteLine(sin(5)); | ||
double c = (double)(np.cos(5) + sin(5)); | ||
Console.WriteLine(c); | ||
dynamic a = np.array(new List<float> { 1, 2, 3 }); | ||
Console.WriteLine(a.dtype); | ||
dynamic b = np.array(new List<float> { 6, 5, 4 }, dtype: np.int32); | ||
Console.WriteLine(b.dtype); | ||
Console.WriteLine(a * b); | ||
Console.ReadKey(); | ||
``` | ||
Output: | ||
``` | ||
1.0 | ||
-0.958924274663 | ||
-0.6752620892 | ||
float64 | ||
int32 | ||
[ 6. 10. 12.] | ||
``` | ||
## Resources | ||
Information on installation, FAQ, troubleshooting, debugging, and | ||
projects using pythonnet can be found in the Wiki: | ||
https://github.com/pythonnet/pythonnet/wiki | ||
Mailing list | ||
https://mail.python.org/mailman/listinfo/pythondotnet | ||
Chat | ||
https://gitter.im/pythonnet/pythonnet | ||
### .NET Foundation | ||
This project is supported by the [.NET Foundation](https://dotnetfoundation.org). |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.