Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for new and init commands in maturin --help #734

Merged
merged 1 commit into from
Dec 7, 2021

Conversation

messense
Copy link
Member

@messense messense commented Dec 7, 2021

Before

❯ maturin --help
maturin 0.12.4
Build and publish crates with pyo3, rust-cpython and cffi bindings as well as rust binaries as python packages

USAGE:
    maturin <SUBCOMMAND>

FLAGS:
    -h, --help
            Prints help information

    -V, --version
            Prints version information


SUBCOMMANDS:
    build          High level API for building wheels from a crate which is also used for the CLI
    develop        Installs the crate as module in the current virtualenv
    help           Prints this message or the help of the given subcommand(s)
    init           Options common to `maturin new` and `maturin init`
    list-python    Searches and lists the available python installations
    new            Options common to `maturin new` and `maturin init`
    publish        An account with a registry, possibly incomplete
    sdist          Build only a source distribution (sdist) without compiling
    upload         An account with a registry, possibly incomplete

Options common to maturin new and maturin init

This is caused by TeXitoi/structopt#333

After

❯ cargo run -- --help
    Finished dev [unoptimized + debuginfo] target(s) in 0.06s
     Running `target/debug/maturin --help`
maturin 0.12.4
Build and publish crates with pyo3, rust-cpython and cffi bindings as well as rust binaries as python packages

USAGE:
    maturin <SUBCOMMAND>

FLAGS:
    -h, --help
            Prints help information

    -V, --version
            Prints version information


SUBCOMMANDS:
    build          High level API for building wheels from a crate which is also used for the CLI
    develop        Installs the crate as module in the current virtualenv
    help           Prints this message or the help of the given subcommand(s)
    init           Create a new cargo project in an existing directory
    list-python    Searches and lists the available python installations
    new            Create a new cargo project
    publish        An account with a registry, possibly incomplete
    sdist          Build only a source distribution (sdist) without compiling
    upload         An account with a registry, possibly incomplete

@netlify
Copy link

netlify bot commented Dec 7, 2021

✔️ Deploy Preview for maturin-guide canceled.

🔨 Explore the source changes: d18f399

🔍 Inspect the deploy log: https://app.netlify.com/sites/maturin-guide/deploys/61aedd17282c6a0007ce9d7c

@messense
Copy link
Member Author

messense commented Dec 7, 2021

cc @davidhewitt

@messense messense merged commit 5b6a2ac into PyO3:main Dec 7, 2021
@messense messense deleted the new-init-doc branch December 7, 2021 05:01
@davidhewitt
Copy link
Member

👍 thanks, sorry I missed this!

bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Dec 23, 2021
https://build.opensuse.org/request/show/942187
by user mia + dimstar_suse
- Update to 0.12.5
  * Fix docs for new and init commands in maturin --help
    gh#PyO3/maturin#734
  * Fix undefined auditwheel policy panic
    gh#PyO3/maturin#740
  * Fix upload::canonicalize_name() regex subst
    gh#PyO3/maturin#741
  * Bump serde from 1.0.130 to 1.0.131
    gh#PyO3/maturin#745
  * Bump sha2 from 0.9.8 to 0.10.0
    gh#PyO3/maturin#746
  * Add Cargo.lock to sdist when --locked or --frozen specified
    gh#PyO3/maturin#749
  * Implement auditwheel repair with patchelf
    gh#PyO3/maturin#742
  * Support pyo3 abi3-py310 feature
    gh#PyO3/maturin#750
- Changes in 0.12.4:
  * Bump anyhow from 1.0.50 to 1.0.51
    gh#PyO3/maturin#717
  * init: new command similar to cargo init
    gh#PyO3/maturin#719
  * Don't package non-path-dep crates in sdist for workspaces
    gh#PyO
wip-sync pushed a commit to NetBSD/pkgsrc-wip that referenced this pull request Jan 3, 2022
* Add support for repairing cross compiled linux wheels in [#754](PyO3/maturin#754)
* Add support for `manylinux_2_28` and `manylinux_2_31` in [#755](PyO3/maturin#755)
* Remove existing so file first in `maturin develop` command to avoid triggering SIGSEV in running process in [#760](PyO3/maturin#760)

* Fix docs for `new` and `init` commands in `maturin --help` in [#734](PyO3/maturin#734)
* Add support for x86_64 Haiku in [#735](PyO3/maturin#735)
* Fix undefined auditwheel policy panic in [#740](PyO3/maturin#740)
* Fix sdist upload for packages where the pkgname contains multiple underscores in [#741](PyO3/maturin#741)
* Implement auditwheel repair with patchelf in [#742](PyO3/maturin#742)
* Add `Cargo.lock` to sdist when `--locked` or `--frozen` specified in [#749](PyO3/maturin#749)
* Infer readme file if not specified in [#751](PyO3/maturin#751)

* Add a `maturin init` command as a companion to `maturin new` in [#719](PyO3/maturin#719)
* Don't package non-path-dep crates in sdist for workspaces in [#720](PyO3/maturin#720)
* Build release packages with `password-storage` feature in [#725](PyO3/maturin#725)
* Add support for x86_64 DargonFly BSD in [#727](PyO3/maturin#727)
* Add a Python import hook in [#729](PyO3/maturin#729)
* Allow pip warnings in `maturin develop` command in [#732](PyO3/maturin#732)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants