luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

examples: add cargo-generate configuration

This commit is contained in:
David Hewitt 2021-12-14 08:29:48 +00:00
parent 39cac9075b
commit ce7e17c0e6
33 changed files with 244 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
examples/README.md
View File

@ -10,3 +10,14 @@ Below is a brief description of each of these:
| `maturin-starter` | A template project which is configured to use [`maturin`](https://github.com/PyO3/maturin) for development. |
| `setuptools-rust-starter` | A template project which is configured to use [`setuptools_rust`](https://github.com/PyO3/setuptools-rust/) for development. |
| `word-count` | A quick performance comparison between word counter implementations written in each of Rust and Python. |
## Creating new projects from these examples
To copy an example, use `cargo-generate`. Follow the commands below, replacing `<example>` with the example to start from:
```bash
$ cargo install cargo-generate
$ cargo generate --git https://github.com/PyO3/pyo3 examples/<example>
```
(`cargo generate` will take a little while to clone the PyO3 repo first; be patient when waiting for the command to run.)

13
examples/decorator/.template/Cargo.toml Normal file
View File

@ -0,0 +1,13 @@
[package]
authors = ["{{authors}}"]
name = "{{project-name}}"
version = "0.1.0"
description = "An example project to get started using PyO3 with maturin"
edition = "2018"
[dependencies]
pyo3 = { version = "{{PYO3_VERSION}}", features = ["extension-module"] }
[lib]
name = "maturin_starter"
crate-type = ["cdylib"]

5
examples/decorator/.template/pre-script.rhai Normal file
View File

@ -0,0 +1,5 @@
variable::set("PYO3_VERSION", "0.15.1");
file::rename(".template/Cargo.toml", "Cargo.toml");
file::rename(".template/pyproject.toml", "pyproject.toml");
file::rename(".template/tox.ini", "tox.ini");
file::delete(".template");

7
examples/decorator/.template/pyproject.toml Normal file
View File

@ -0,0 +1,7 @@
[build-system]
requires = ["maturin>=0.12,<0.13"]
build-backend = "maturin"
[project]
name = "{{project-name}}"
version = "0.1.0"

7
examples/decorator/.template/tox.ini Normal file
View File

@ -0,0 +1,7 @@
[tox]
isolated_build = true
[testenv]
description = Run the unit tests under {basepython}
deps = -rrequirements-dev.txt
commands = pytest {posargs}

5
examples/decorator/cargo-generate.toml Normal file
View File

@ -0,0 +1,5 @@
[template]
ignore = [".tox"]
[hooks]
pre = [".template/pre-script.rhai"]

13
examples/decorator/pyproject.toml
View File

@ -1,3 +1,16 @@
[build-system]
requires = ["maturin>=0.12,<0.13"]
build-backend = "maturin"
[project]
name = "decorator"
version = "0.1.0"
classifier=[
"License :: OSI Approved :: MIT License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Rust",
"Operating System :: POSIX",
"Operating System :: MacOS :: MacOS X",
]

13
examples/maturin-starter/.template/Cargo.toml Normal file
View File

@ -0,0 +1,13 @@
[package]
authors = ["{{authors}}"]
name = "{{project-name}}"
version = "0.1.0"
description = "An example project to get started using PyO3 with maturin"
edition = "2018"
[dependencies]
pyo3 = { version = "{{PYO3_VERSION}}", features = ["extension-module"] }
[lib]
name = "maturin_starter"
crate-type = ["cdylib"]

5
examples/maturin-starter/.template/pre-script.rhai Normal file
View File

@ -0,0 +1,5 @@
variable::set("PYO3_VERSION", "0.15.1");
file::rename(".template/Cargo.toml", "Cargo.toml");
file::rename(".template/pyproject.toml", "pyproject.toml");
file::rename(".template/tox.ini", "tox.ini");
file::delete(".template");

7
examples/maturin-starter/.template/pyproject.toml Normal file
View File

@ -0,0 +1,7 @@
[build-system]
requires = ["maturin>=0.12,<0.13"]
build-backend = "maturin"
[project]
name = "{{project-name}}"
version = "0.1.0"

7
examples/maturin-starter/.template/tox.ini Normal file
View File

@ -0,0 +1,7 @@
[tox]
isolated_build = true
[testenv]
description = Run the unit tests under {basepython}
deps = -rrequirements-dev.txt
commands = pytest {posargs}

11
examples/maturin-starter/Cargo.toml
View File

@ -16,14 +16,3 @@ features = ["extension-module"]
[lib]
name = "maturin_starter"
crate-type = ["cdylib"]
[package.metadata.maturin]
classifier=[
"License :: OSI Approved :: MIT License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Rust",
"Operating System :: POSIX",
"Operating System :: MacOS :: MacOS X",
]

11
examples/maturin-starter/README.md
View File

@ -22,3 +22,14 @@ Alternatively, install tox and run the tests inside an isolated environment:
```shell
tox -e py
```
## Copying this example
Use `cargo-generate`:
```bash
$ cargo install cargo-generate
$ cargo generate --git https://github.com/PyO3/pyo3 examples/maturin-starter
```
(`cargo generate` will take a little while to clone the PyO3 repo first; be patient when waiting for the command to run.)

5
examples/maturin-starter/cargo-generate.toml Normal file
View File

@ -0,0 +1,5 @@
[template]
ignore = [".tox"]
[hooks]
pre = [".template/pre-script.rhai"]

13
examples/maturin-starter/pyproject.toml
View File

@ -1,3 +1,16 @@
[build-system]
requires = ["maturin>=0.12,<0.13"]
build-backend = "maturin"
[project]
name = "maturin-starter"
version = "0.1.0"
classifier=[
"License :: OSI Approved :: MIT License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Rust",
"Operating System :: POSIX",
"Operating System :: MacOS :: MacOS X",
]

13
examples/setuptools-rust-starter/.template/Cargo.toml Normal file
View File

@ -0,0 +1,13 @@
[package]
authors = ["{{authors}}"]
name = "{{project-name}}"
version = "0.1.0"
description = "An example project to get started using PyO3 with setuptools_rust"
edition = "2018"
[dependencies]
pyo3 = { version = "{{PYO3_VERSION}}", features = ["extension-module"] }
[lib]
name = "setuptools_rust_starter"
crate-type = ["cdylib"]

5
examples/setuptools-rust-starter/.template/pre-script.rhai Normal file
View File

@ -0,0 +1,5 @@
variable::set("PYO3_VERSION", "0.15.1");
file::rename(".template/Cargo.toml", "Cargo.toml");
file::rename(".template/setup.cfg", "setup.cfg");
file::rename(".template/tox.ini", "tox.ini");
file::delete(".template");

9
examples/setuptools-rust-starter/.template/setup.cfg Normal file
View File

@ -0,0 +1,9 @@
[metadata]
name = {{project-name}}
version = 0.1.0
packages =
setuptools_rust_starter
[options]
include_package_data = True
zip_safe = False

7
examples/setuptools-rust-starter/.template/tox.ini Normal file
View File

@ -0,0 +1,7 @@
[tox]
isolated_build = true
[testenv]
description = Run the unit tests under {basepython}
deps = -rrequirements-dev.txt
commands = pytest {posargs}

12
examples/setuptools-rust-starter/Cargo.toml
View File

@ -16,15 +16,3 @@ features = ["extension-module"]
[lib]
name = "setuptools_rust_starter"
crate-type = ["cdylib"]
[package.metadata.maturin]
classifier=[
"License :: OSI Approved :: MIT License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Rust",
"Operating System :: POSIX",
"Operating System :: MacOS :: MacOS X",
]

5
examples/setuptools-rust-starter/cargo-generate.toml Normal file
View File

@ -0,0 +1,5 @@
[template]
ignore = [".tox"]
[hooks]
pre = [".template/pre-script.rhai"]

2
examples/setuptools-rust-starter/pyproject.toml Normal file
View File

@ -0,0 +1,2 @@
[build-system]
requires = ["setuptools>=41.0.0", "wheel", "setuptools_rust>=1.0.0"]

17
examples/setuptools-rust-starter/setup.cfg Normal file
View File

@ -0,0 +1,17 @@
[metadata]
name = setuptools-rust-starter
version = 0.1.0
packages =
setuptools_rust_starter
classifiers =
License :: OSI Approved :: MIT License
Development Status :: 3 - Alpha
Intended Audience :: Developers
Programming Language :: Python
Programming Language :: Rust
Operating System :: POSIX
Operating System :: MacOS :: MacOS X
[options]
include_package_data = True
zip_safe = False

22
examples/setuptools-rust-starter/setup.py
View File

@ -1,26 +1,6 @@
from setuptools import setup
from setuptools_rust import RustExtension
setup(
name="setuptools-rust-starter",
version="0.1.0",
classifiers=[
"License :: OSI Approved :: MIT License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Rust",
"Operating System :: POSIX",
"Operating System :: MacOS :: MacOS X",
],
packages=["setuptools_rust_starter"],
rust_extensions=[
RustExtension(
"setuptools_rust_starter._setuptools_rust_starter",
debug=False,
),
],
include_package_data=True,
zip_safe=False,
rust_extensions=[RustExtension("setuptools_rust_starter._setuptools_rust_starter")],
)

13
examples/word-count/.template/Cargo.toml Normal file
View File

@ -0,0 +1,13 @@
[package]
authors = ["{{authors}}"]
name = "{{project-name}}"
version = "0.1.0"
edition = "2018"
[dependencies]
rayon = "1.0.2"
pyo3 = { version = "{{PYO3_VERSION}}", features = ["extension-module"] }
[lib]
name = "word_count"
crate-type = ["cdylib"]

4
examples/word-count/.template/pre-script.rhai Normal file
View File

@ -0,0 +1,4 @@
variable::set("PYO3_VERSION", "0.15.1");
file::rename(".template/Cargo.toml", "Cargo.toml");
file::rename(".template/tox.ini", "tox.ini");
file::delete(".template");

6
examples/word-count/.template/pyproject.toml Normal file
View File

@ -0,0 +1,6 @@
[build-system]
requires = ["setuptools>=41.0.0", "wheel", "setuptools_rust>=1.0.0"]
[project]
name = "{{project-name}}"
version = "0.1.0"

9
examples/word-count/.template/setup.cfg Normal file
View File

@ -0,0 +1,9 @@
[metadata]
name = {{project-name}}
version = 0.1.0
packages =
word_count
[options]
include_package_data = True
zip_safe = False

7
examples/word-count/.template/tox.ini Normal file
View File

@ -0,0 +1,7 @@
[tox]
isolated_build = true
[testenv]
description = Run the unit tests under {basepython}
deps = -rrequirements-dev.txt
commands = pytest {posargs}

5
examples/word-count/cargo-generate.toml Normal file
View File

@ -0,0 +1,5 @@
[template]
ignore = [".tox"]
[hooks]
pre = [".template/pre-script.rhai"]

2
examples/word-count/pyproject.toml
View File

@ -1,2 +1,2 @@
[build-system]
requires = ["setuptools>=41.0.0", "wheel", "setuptools_rust>=0.10.2"]
requires = ["setuptools>=41.0.0", "wheel", "setuptools_rust>=1.0.0"]

17
examples/word-count/setup.cfg Normal file
View File

@ -0,0 +1,17 @@
[metadata]
name = word-count
version = 0.1.0
packages =
word_count
classifiers =
License :: OSI Approved :: MIT License
Development Status :: 3 - Alpha
Intended Audience :: Developers
Programming Language :: Python
Programming Language :: Rust
Operating System :: POSIX
Operating System :: MacOS :: MacOS X
[options]
include_package_data = True
zip_safe = False

17
examples/word-count/setup.py
View File

@ -1,21 +1,6 @@
from setuptools import setup
from setuptools_rust import RustExtension
setup(
name="word-count",
version="0.1.0",
classifiers=[
"License :: OSI Approved :: MIT License",
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Rust",
"Operating System :: POSIX",
"Operating System :: MacOS :: MacOS X",
],
packages=["word_count"],
rust_extensions=[RustExtension("word_count.word_count", "Cargo.toml", debug=False)],
include_package_data=True,
zip_safe=False,
rust_extensions=[RustExtension("word_count.word_count", debug=False)],
)