Skip to content

Commit d8df703

Browse files
committed
address review comments
1 parent bb0368e commit d8df703

11 files changed

+42
-45
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
[![](https://img.shields.io/badge/pyenv-graalpy-blue)](#start-replacing-cpython-with-graalpy)
55
</a> [![Join Slack][badge-slack]][slack] [![GraalVM on Twitter][badge-twitter]][twitter] [![License](https://img.shields.io/badge/license-UPL-green)](#license)
66

7-
GraalPy is a high-performance implementation of the [Python](https://www.python.org/) language for the JVM built on [GraalVM](https://www.graalvm.org/) technology.
7+
GraalPy is a high-performance implementation of the [Python](https://www.python.org/) language for the JVM built on [GraalVM](https://www.graalvm.org/).
88
GraalPy has first-class support for embedding in Java and can turn Python applications into fast, standalone binaries.
99

1010
## Why GraalPy?
1111

12-
**Low-overhead integration with Java and other languages.**
12+
**Low-overhead integration with Java and other languages**
1313

1414
* Use [Python in Java](docs/user/Interoperability.md) applications on GraalVM JDK, Oracle JDK, or OpenJDK
1515
* Use JVM tools like [Maven](docs/user/README.md), JFR, or [GraalVM Native Image](docs/user/Native-Images-with-Python.md)
@@ -20,19 +20,19 @@ GraalPy has first-class support for embedding in Java and can turn Python applic
2020
* Install [packages](docs/user/Python-Runtime.md#installing-packages) like *NumPy*, *PyTorch*, or *Tensorflow*; run [Hugging Face](https://huggingface.co/) models like *Stable Diffusion* or *GPT*
2121
* See if the packages you need work with our [Python Compatibility Checker](https://www.graalvm.org/python/compatibility/)
2222
* Use almost any standard Python feature, the CPython tests run on every commit and pass ~85%
23-
![](docs/user/mcd.svg)<sup>
23+
![](docs/user/assets/mcd.svg)<sup>
2424
We run the tests of the [top PyPI packages](https://hugovk.github.io/top-pypi-packages/) on GraalPy every day.
2525
For more than 96% of the top PyPI packages, there is at least one recent version that installs successfully and we are currently passing over 50% of all tests those top packages.
2626
</sup>
2727

2828
**Runs Python code faster**
2929

3030
* Pure Python code is often faster than on CPython after JIT compilation
31-
* C extension performance near CPython, but varies depending on the specific interactions of native and Python code
31+
* C extension performance is near CPython, but varies depending on the specific interactions of native and Python code
3232
* GraalPy is ~4x faster than CPython on the official [Python Performance Benchmark Suite](https://pyperformance.readthedocs.io/)
33-
![](docs/user/performance.svg)<sup>
33+
![](docs/user/assets/performance.svg)<sup>
3434
Benchmarks run via `pip install pyperformance && pyperformance run` on each of CPython and GraalPy.
35-
Harness and benchmarks adapted by hand for Jython due to missing Python 3 support.
35+
Harness and benchmarks were adapted by hand for Jython due to missing Python 3 support.
3636
Each interpreter was installed via <tt>[pyenv](https://github.com/pyenv/pyenv)</tt>.
3737
Geomean speedup was calculated against CPython on the intersection of benchmarks that run on all interpreters.
3838
</sup>
@@ -81,12 +81,12 @@ Thanks to our integration with GraalVM Native Image, we can deploy Python applic
8181
* Linux
8282

8383
The easiest way to install GraalPy on Linux is to use [Pyenv](https://github.com/pyenv/pyenv) (the Python version manager).
84-
To install version 23.1.1 using Pyenv, run the following commands:
84+
To install version 23.1.2 using Pyenv, run the following commands:
8585
```bash
86-
pyenv install graalpy-23.1.1
86+
pyenv install graalpy-23.1.2
8787
```
8888
```bash
89-
pyenv shell graalpy-23.1.1
89+
pyenv shell graalpy-23.1.2
9090
```
9191

9292
Alternatively, you can download a compressed GraalPy installation file from [GitHub releases](https://github.com/oracle/graalpython/releases).
@@ -97,12 +97,12 @@ Thanks to our integration with GraalVM Native Image, we can deploy Python applic
9797
* macOS
9898

9999
The easiest way to install GraalPy on macOS is to use [Pyenv](https://github.com/pyenv/pyenv) (the Python version manager).
100-
To install version 23.1.1 using Pyenv, run the following commands:
100+
To install version 23.1.2 using Pyenv, run the following commands:
101101
```bash
102-
pyenv install graalpy-23.1.1
102+
pyenv install graalpy-23.1.2
103103
```
104104
```bash
105-
pyenv shell graalpy-23.1.1
105+
pyenv shell graalpy-23.1.2
106106
```
107107
Alternatively, you can download a compressed GraalPy installation file from [GitHub releases](https://github.com/oracle/graalpython/releases).
108108

@@ -113,7 +113,7 @@ Thanks to our integration with GraalVM Native Image, we can deploy Python applic
113113
```
114114
For example:
115115
```bash
116-
sudo xattr -r -d com.apple.quarantine ~/.pyenv/versions/graalpy-23.1.1
116+
sudo xattr -r -d com.apple.quarantine ~/.pyenv/versions/graalpy-23.1.2
117117
```
118118
3. Uncompress the file and update your `PATH` environment variable to include to the _graalpy-XX.Y.Z-macos-amd64/bin_ (or _graalpy-XX.Y.Z-macos-aarch64/bin_) directory.
119119

@@ -143,7 +143,7 @@ The _setup-python_ action supports GraalPy:
143143

144144
Most existing Jython code that uses Java integration will be based on a stable Jython release&mdash;however, these are only available in Python 2.x versions.
145145
To migrate your code from Python 2 to Python 3, follow [the official guide from the Python community](https://docs.python.org/3/howto/pyporting.html).
146-
GraalPy also provides a [special mode](docs/user/Python-on-JVM.md) to facilitate migration.
146+
GraalPy provides a [special mode](docs/user/Python-on-JVM.md) to facilitate migration.
147147
To run Jython scripts, you need to use a GraalPy distribution running on the JVM so you can access Java classes from Python scripts.
148148

149149
* Linux
@@ -161,7 +161,7 @@ To run Jython scripts, you need to use a GraalPy distribution running on the JVM
161161
```
162162
For example:
163163
```bash
164-
sudo xattr -r -d com.apple.quarantine ~/.pyenv/versions/graalpy-23.1.1
164+
sudo xattr -r -d com.apple.quarantine ~/.pyenv/versions/graalpy-23.1.2
165165
```
166166
3. Uncompress the file and update your `PATH` environment variable to include to the _graalpy-jvm-XX.Y.Z-macos-amd64/bin_ (or _graalpy-jvm-XX.Y.Z-macos-aarch64/bin_) directory.
167167
4. Run your scripts with `graalpy --python.EmulateJython`.
@@ -181,24 +181,24 @@ To run Jython scripts, you need to use a GraalPy distribution running on the JVM
181181

182182
## Documentation
183183

184-
Our [Quick Reference Sheet](https://www.graalvm.org/uploads/quick-references/GraalPy_v1/quick-reference-graalpy-v1(eu_a4).pdf) should help you get started.
184+
[GraalPy Quick Reference Sheet](https://www.graalvm.org/uploads/quick-references/GraalPy_v1/quick-reference-graalpy-v1(eu_a4).pdf) should help you get started.
185185
More GraalPy-specific user documentation is available in [docs/user](docs/user).
186186
General documentation about [polyglot programming](https://www.graalvm.org/latest/reference-manual/polyglot-programming/) and [language embedding](https://www.graalvm.org/latest/reference-manual/embed-languages/) is available on the GraalVM website.
187187

188188
## Community
189189

190-
The best way to get in touch with us is to join the `#graalpy` channel on [GraalVM Slack][slack] or write to us on [Twitter][twitter]
190+
The best way to get in touch with us is to join the `#graalpy` channel on [GraalVM Slack][slack] or [tweet us][twitter].
191191

192192
## Contributing
193193

194-
If you're thinking about contributing something to this repository, you will need to sign the [Oracle Contributor Agreement](https://www.graalvm.org/community/contributors/) for us to able to merge your work.
195-
Please also take note of our [code of conduct](https://www.graalvm.org/community/conduct/) for contributors.
196-
197194
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md).
198195

196+
If you're thinking about contributing something to this repository, you will need to sign the [Oracle Contributor Agreement](https://www.graalvm.org/community/contributors/) for us to able to merge your work.
197+
Also take a look at the [code of conduct](https://www.graalvm.org/community/conduct/) for contributors.
198+
199199
## Security
200200
201-
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process.
201+
Consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process.
202202
203203
## License
204204

docs/user/Embedding-Permissions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ layout: docs-experimental
33
toc_group: python
44
link_title: Embedding Permissions
55
permalink: /reference-manual/python/Embedding-Permissions/
6-
redirect_from:
7-
- /reference-manual/python/OSInterface/
6+
redirect_from: /reference-manual/python/OSInterface/
87
---
98

109
# Permissions for Python Embeddings

docs/user/Interoperability.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ layout: docs-experimental
33
toc_group: python
44
link_title: Interoperability
55
permalink: /reference-manual/python/Interoperability/
6-
redirect_from: /reference-manual/python/Interoperability/
76
---
87
# Interoperability
98

@@ -77,7 +76,7 @@ For example, if you have already configured a Maven project with GraalPy, add th
7776
<dependency>
7877
<groupId>org.graalvm.polyglot</groupId>
7978
<artifactId>js</artifactId>
80-
<version>23.1.1</version>
79+
<version>23.1.2</version>
8180
</dependency>
8281
```
8382

docs/user/Native-Images-with-Python.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
layout: docs-experimental
33
toc_group: python
44
link_title: Native Java-Python Applications
5-
permalink: /reference-manual/python/native-image/
5+
permalink: /reference-manual/python/native-applications/
6+
redirect_from: /reference-manual/python/native-image/
67
---
78

89
# Native Executables with Python

docs/user/Performance.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ layout: docs-experimental
33
toc_group: python
44
link_title: Python Performance
55
permalink: /reference-manual/python/Performance/
6-
redirect_from:
7-
- /reference-manual/python/ParserDetails/
6+
redirect_from: /reference-manual/python/ParserDetails/
87
---
98

109
# Python Performance
@@ -13,7 +12,7 @@ redirect_from:
1312

1413
GraalPy uses the state-of-the-art just-in-time (JIT) compiler of GraalVM.
1514
When JIT compiled, GraalPy runs Python code ~4x faster than CPython on the official [Python Performance Benchmark Suite](https://pyperformance.readthedocs.io/).
16-
![](performance.svg)
15+
![](assets/performance.svg)
1716

1817
These benchmarks can be run by installing the `pyperformance` package and calling `pyperformance run` on each of CPython and GraalPy.
1918
To get the Jython numbers we adapted the harness and benchmarks because of missing Python 3 support in Jython.

docs/user/Python-Runtime.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ layout: docs-experimental
33
toc_group: python
44
link_title: Python Runtime
55
permalink: /reference-manual/python/Python-Runtime/
6-
redirect_from:
7-
- /reference-manual/python/Packages/
6+
redirect_from: /reference-manual/python/Packages/
87
---
98

109
# GraalPy as a CPython Replacement
@@ -77,12 +76,12 @@ The four GraalPy runtimes are identified as follows, using the general pattern _
7776
### Linux
7877

7978
The easiest way to install GraalPy on Linux is to use [Pyenv](https://github.com/pyenv/pyenv) (the Python version manager).
80-
To install version 23.1.1 using Pyenv, run the following commands:
79+
To install version 23.1.2 using Pyenv, run the following commands:
8180
```bash
82-
pyenv install graalpy-23.1.1
81+
pyenv install graalpy-23.1.2
8382
```
8483
```bash
85-
pyenv shell graalpy-23.1.1
84+
pyenv shell graalpy-23.1.2
8685
```
8786

8887
Alternatively, you can download a compressed GraalPy installation file from [GitHub releases](https://github.com/oracle/graalpython/releases).
@@ -93,12 +92,12 @@ Alternatively, you can download a compressed GraalPy installation file from [Git
9392
### macOS
9493

9594
The easiest way to install GraalPy on macOS is to use [Pyenv](https://github.com/pyenv/pyenv) (the Python version manager).
96-
To install version 23.1.1 using Pyenv, run the following commands:
95+
To install version 23.1.2 using Pyenv, run the following commands:
9796
```bash
98-
pyenv install graalpy-23.1.1
97+
pyenv install graalpy-23.1.2
9998
```
10099
```bash
101-
pyenv shell graalpy-23.1.1
100+
pyenv shell graalpy-23.1.2
102101
```
103102
Alternatively, you can download a compressed GraalPy installation file from [GitHub releases](https://github.com/oracle/graalpython/releases).
104103

@@ -109,7 +108,7 @@ Alternatively, you can download a compressed GraalPy installation file from [Git
109108
```
110109
For example:
111110
```bash
112-
sudo xattr -r -d com.apple.quarantine ~/.pyenv/versions/graalpy-23.1.1
111+
sudo xattr -r -d com.apple.quarantine ~/.pyenv/versions/graalpy-23.1.2
113112
```
114113
3. Uncompress the file and update your `PATH` environment variable to include to the _graalpy-XX.Y.Z-macos-amd64/bin_ (or _graalpy-XX.Y.Z-macos-aarch64/bin_) directory.
115114

@@ -144,7 +143,7 @@ This generates wrapper scripts and makes the implementation usable from a shell
144143
```
145144
For example:
146145
```bash
147-
graalpy -m venv ~/.virtualenvs/graalpy-23.1.1
146+
graalpy -m venv ~/.virtualenvs/graalpy-23.1.2
148147
```
149148
150149
2. Activate the environment in your shell session:
@@ -153,7 +152,7 @@ This generates wrapper scripts and makes the implementation usable from a shell
153152
```
154153
For example:
155154
```bash
156-
source ~/.virtualenvs/graalpy-23.1.1/bin/activate
155+
source ~/.virtualenvs/graalpy-23.1.2/bin/activate
157156
```
158157
159158
Multiple executables are available in the virtual environment, including: `python`, `python3`, and `graalpy`.

docs/user/Python-Standalone-Applications.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
layout: docs-experimental
33
toc_group: python
44
link_title: Python Standalone Applications
5-
permalink: /reference-manual/python/standalone-binaries/
5+
permalink: /reference-manual/python/standalone-applications/
6+
redirect_from: /reference-manual/python/standalone-binaries/
67
---
78

89
# Python Standalone Applications

docs/user/Python-on-JVM.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ layout: docs-experimental
33
toc_group: python
44
link_title: Jython Compatibility
55
permalink: /reference-manual/python/Modern-Python-on-JVM/
6-
redirect_from:
7-
- /reference-manual/python/Jython/
6+
redirect_from: /reference-manual/python/Jython/
87
---
98

109
# Modern Python for the JVM

docs/user/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ The Java code and the _pom.xml_ file are heavily documented and the generated co
6868
2. Open your project configuration file, _app/build.gradle_, and modify it as follows.
6969
- Include the GraalPy support and the [GraalVM SDK Polyglot API](https://www.graalvm.org/sdk/javadoc/org/graalvm/polyglot/package-summary.html) in the `dependencies` section:
7070
```kotlin
71-
implementation("org.graalvm.polyglot:polyglot:23.1.1")
72-
implementation("org.graalvm.polyglot:python:23.1.1")
71+
implementation("org.graalvm.polyglot:polyglot:23.1.2")
72+
implementation("org.graalvm.polyglot:python:23.1.2")
7373
```
7474

7575
- We recommend you use the Java modules build. Add the appropriate plugin to the `plugins` section:
File renamed without changes.

0 commit comments

Comments
 (0)