Fix install section of README (#3)

* Fix install section of README

* fix

* Support Python 3.11

Author: vbkaisetsu

.github/workflows/CI.yml

@@ -5,94 +5,99 @@ on:
   pull_request:
 
 jobs:
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - uses: dtolnay/rust-toolchain@stable
+    - uses: PyO3/maturin-action@v1
+      with:
+        command: sdist
+    - name: Upload wheels
+      uses: actions/upload-artifact@v3
+      with:
+        name: wheels
+        path: target/wheels
+
   linux:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
         target: [x86_64, i686]
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        default: true
-    - uses: messense/maturin-action@v1
+    - uses: dtolnay/rust-toolchain@stable
+    - uses: PyO3/maturin-action@v1
       with:
         target: ${{ matrix.target }}
         manylinux: auto
-        args: -i ${{ matrix.python-version }} --release -o dist
+        args: -i ${{ matrix.python-version }} --release
     - name: Upload wheels
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: wheels
-        path: dist
+        path: target/wheels
 
   windows:
     runs-on: windows-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
         target: [x64, x86]
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
         architecture: ${{ matrix.target }}
-    - uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        default: true
-    - uses: messense/maturin-action@v1
+    - uses: dtolnay/rust-toolchain@stable
+    - uses: PyO3/maturin-action@v1
       with:
         target: ${{ matrix.target }}
         manylinux: auto
-        args: -i ${{ matrix.python-version }} --release -o dist
+        args: -i ${{ matrix.python-version }} --release
     - name: Upload wheels
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: wheels
-        path: dist
+        path: target/wheels
 
   macos:
     runs-on: macos-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        default: true
-    - uses: messense/maturin-action@v1
+    - uses: dtolnay/rust-toolchain@stable
+    - uses: PyO3/maturin-action@v1
       with:
         target: ${{ matrix.target }}
         manylinux: auto
-        args: -i ${{ matrix.python-version }} --release -o dist --universal2
+        args: -i ${{ matrix.python-version }} --release --universal2
     - name: Upload wheels
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: wheels
-        path: dist
+        path: target/wheels
 
   release:
     name: Release
     runs-on: ubuntu-latest
     if: "startsWith(github.ref, 'refs/tags/')"
-    needs: [ macos, windows, linux ]
+    needs: [ sdist, macos, windows, linux ]
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v3
         with:
           name: wheels
       - name: Publish to PyPI

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "python-daachorse"
-version = "0.1.5"
+version = "0.1.6"
 edition = "2021"
 authors = [
     "Koichi Akabe <vbkaisetsu@gmail.com>",
@@ -17,7 +17,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 daachorse = "1.0.0" # MIT or Apache-2.0
-pyo3 = { version = "0.17.1", features = ["extension-module"] } # MIT or Apache-2.0
+pyo3 = { version = "0.17.3", features = ["extension-module"] } # MIT or Apache-2.0
 
 [profile.release]
 lto = true

README.md

@@ -8,18 +8,27 @@ This is a Python wrapper.
 
 ## Installation
 
-To use daachorse, run the following command:
+### Install pre-built package from PyPI
+
+Run the following command:
 
 ```
 $ pip install daachorse
 ```
 
-You can also build a package as follows:
+### Build from source
+
+You need to install the Rust compiler following [the documentation](https://www.rust-lang.org/tools/install) beforehand.
+daachorse uses `pyproject.toml`, so you also need to upgrade pip to version 19 or later.
+
+```
+$ pip install --upgrade pip
+```
+
+After setting up the environment, you can install daachorse as follows:
 
 ```
-$ python3 -m pip install maturin  # installs maturin
-$ python3 -m maturin build --release -o dist  # whl file is placed in dist
-$ python3 -m pip install dist/*.whl  # installs daachorse
+$ pip install git+https://github.com/daac-tools/python-daachorse
 ```
 
 ## Example usage

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["maturin>=0.13,<0.14"]
+requires = ["maturin>=0.14,<0.15"]
 build-backend = "maturin"
 
 [project]