cargo-xwin


Namecargo-xwin JSON
Version 0.10.4 PyPI version JSON
download
home_pageNone
SummaryCross compile Cargo project to Windows MSVC target with ease
upload_time2022-09-07 16:33:32
maintainerNone
docs_urlNone
authorNone
requires_python
licenseMIT
keywords windows cargo msvc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cargo-xwin

_formerly cargo-xwinbuild_

[![CI](https://github.com/messense/cargo-xwin/workflows/CI/badge.svg)](https://github.com/messense/cargo-xwin/actions?query=workflow%3ACI)
[![Crates.io](https://img.shields.io/crates/v/cargo-xwin.svg)](https://crates.io/crates/cargo-xwin)
[![docs.rs](https://docs.rs/cargo-xwin/badge.svg)](https://docs.rs/cargo-xwin/)
[![PyPI](https://img.shields.io/pypi/v/cargo-xwin.svg)](https://pypi.org/project/cargo-xwin)
[![Docker Image](https://img.shields.io/docker/pulls/messense/cargo-xwin.svg?maxAge=2592000)](https://hub.docker.com/r/messense/cargo-xwin/)

> 🚀 Help me to become a full-time open-source developer by [sponsoring me on GitHub](https://github.com/sponsors/messense)

Cross compile Cargo project to Windows msvc target with ease.

**By using this software you are consented to accept the license at [https://go.microsoft.com/fwlink/?LinkId=2086102](https://go.microsoft.com/fwlink/?LinkId=2086102)**

## Prerequisite

1. For pure Rust project, no prerequisites needed.
2. For C/C++ dependencies, install [clang](https://clang.llvm.org/).
3. For assembly dependencies, install `llvm-tools-preview` component via `rustup component add llvm-tools-preview` or install [llvm](https://llvm.org).

## Installation

```bash
cargo install cargo-xwin
```

You can also install it using pip:

```bash
pip install cargo-xwin
```

We also provide a [Docker image](https://hub.docker.com/r/messense/cargo-xwin) which has wine pre-installed in addition to cargo-xwin and Rust,
for example to build for x86_64 Windows:

```bash
docker run --rm -it -v $(pwd):/io -w /io messense/cargo-xwin \
  cargo xwin build --release --target x86_64-pc-windows-msvc
```

## Usage

1. Install Rust Windows msvc target via rustup, for example, `rustup target add x86_64-pc-windows-msvc`
2. Run `cargo xwin build`, for example, `cargo xwin build --target x86_64-pc-windows-msvc`

### Run tests with wine

With wine installed, you can run tests with the `cargo xwin test` command,
for example, `cargo xwin test --target x86_64-pc-windows-msvc`

### Customization

The Microsoft CRT and Windows SDK can be customized using the following environment variables or CLI options.

| Environment Variable | CLI option         | Description                                                                                                        |
|----------------------|--------------------|--------------------------------------------------------------------------------------------------------------------|
| `XWIN_ARCH`          | `--xwin-arch`      | The architectures to include, defaults to `x86_64,aarch64`, possible values: x86, x86_64, aarch, aarch64           |
| `XWIN_VARIANT`       | `--xwin-variant`   | The variants to include, defaults to `desktop`, possible values: desktop, onecore, spectre                         |
| `XWIN_VERSION`       | `--xwin-version`   | The version to retrieve, defaults to 16, can either be a major version of 15 or 16, or a `<major>.<minor>` version |
| `XWIN_CACHE_DIR`     | `--xwin-cache-dir` | xwin cache directory to put CRT and SDK files                                                                      |

### CMake Support

Some Rust crates use the [cmake](https://github.com/alexcrichton/cmake-rs) crate to build C/C++ dependencies,
cargo-xwin will generate a [CMake toolchain](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html) file
automatically to make cross compilation work out of the box.

**[ninja](https://ninja-build.org/) is required** to enable CMake support.

## License

This work is released under the MIT license. A copy of the license is provided
in the [LICENSE](./LICENSE) file.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cargo-xwin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": null,
    "keywords": "windows,cargo,msvc",
    "author": null,
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# cargo-xwin\n\n_formerly cargo-xwinbuild_\n\n[![CI](https://github.com/messense/cargo-xwin/workflows/CI/badge.svg)](https://github.com/messense/cargo-xwin/actions?query=workflow%3ACI)\n[![Crates.io](https://img.shields.io/crates/v/cargo-xwin.svg)](https://crates.io/crates/cargo-xwin)\n[![docs.rs](https://docs.rs/cargo-xwin/badge.svg)](https://docs.rs/cargo-xwin/)\n[![PyPI](https://img.shields.io/pypi/v/cargo-xwin.svg)](https://pypi.org/project/cargo-xwin)\n[![Docker Image](https://img.shields.io/docker/pulls/messense/cargo-xwin.svg?maxAge=2592000)](https://hub.docker.com/r/messense/cargo-xwin/)\n\n> \ud83d\ude80 Help me to become a full-time open-source developer by [sponsoring me on GitHub](https://github.com/sponsors/messense)\n\nCross compile Cargo project to Windows msvc target with ease.\n\n**By using this software you are consented to accept the license at [https://go.microsoft.com/fwlink/?LinkId=2086102](https://go.microsoft.com/fwlink/?LinkId=2086102)**\n\n## Prerequisite\n\n1. For pure Rust project, no prerequisites needed.\n2. For C/C++ dependencies, install [clang](https://clang.llvm.org/).\n3. For assembly dependencies, install `llvm-tools-preview` component via `rustup component add llvm-tools-preview` or install [llvm](https://llvm.org).\n\n## Installation\n\n```bash\ncargo install cargo-xwin\n```\n\nYou can also install it using pip:\n\n```bash\npip install cargo-xwin\n```\n\nWe also provide a [Docker image](https://hub.docker.com/r/messense/cargo-xwin) which has wine pre-installed in addition to cargo-xwin and Rust,\nfor example to build for x86_64 Windows:\n\n```bash\ndocker run --rm -it -v $(pwd):/io -w /io messense/cargo-xwin \\\n  cargo xwin build --release --target x86_64-pc-windows-msvc\n```\n\n## Usage\n\n1. Install Rust Windows msvc target via rustup, for example, `rustup target add x86_64-pc-windows-msvc`\n2. Run `cargo xwin build`, for example, `cargo xwin build --target x86_64-pc-windows-msvc`\n\n### Run tests with wine\n\nWith wine installed, you can run tests with the `cargo xwin test` command,\nfor example, `cargo xwin test --target x86_64-pc-windows-msvc`\n\n### Customization\n\nThe Microsoft CRT and Windows SDK can be customized using the following environment variables or CLI options.\n\n| Environment Variable | CLI option         | Description                                                                                                        |\n|----------------------|--------------------|--------------------------------------------------------------------------------------------------------------------|\n| `XWIN_ARCH`          | `--xwin-arch`      | The architectures to include, defaults to `x86_64,aarch64`, possible values: x86, x86_64, aarch, aarch64           |\n| `XWIN_VARIANT`       | `--xwin-variant`   | The variants to include, defaults to `desktop`, possible values: desktop, onecore, spectre                         |\n| `XWIN_VERSION`       | `--xwin-version`   | The version to retrieve, defaults to 16, can either be a major version of 15 or 16, or a `<major>.<minor>` version |\n| `XWIN_CACHE_DIR`     | `--xwin-cache-dir` | xwin cache directory to put CRT and SDK files                                                                      |\n\n### CMake Support\n\nSome Rust crates use the [cmake](https://github.com/alexcrichton/cmake-rs) crate to build C/C++ dependencies,\ncargo-xwin will generate a [CMake toolchain](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html) file\nautomatically to make cross compilation work out of the box.\n\n**[ninja](https://ninja-build.org/) is required** to enable CMake support.\n\n## License\n\nThis work is released under the MIT license. A copy of the license is provided\nin the [LICENSE](./LICENSE) file.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Cross compile Cargo project to Windows MSVC target with ease",
    "version": "0.10.4",
    "split_keywords": [
        "windows",
        "cargo",
        "msvc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "md5": "457d7f73fc812ef506a7b19848003cf8",
                "sha256": "6519e17dc5761a0b178ac0b5d1ea7ec91886d1109ef44eee57e6e13a96933e42"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl",
            "has_sig": false,
            "md5_digest": "457d7f73fc812ef506a7b19848003cf8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5424508,
            "upload_time": "2022-09-07T16:33:32",
            "upload_time_iso_8601": "2022-09-07T16:33:32.911574Z",
            "url": "https://files.pythonhosted.org/packages/0d/50/719f9a52e8d30c843d96d441425ef4d34a1b8082cd1344f37fcb9d4c9425/cargo_xwin-0.10.4-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "b827b656b536763b57745dcecbb67860",
                "sha256": "d3515ffe9a1a4a4a0fb219c7cba05a9740daa557e4de71a53c32688250565b8a"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
            "has_sig": false,
            "md5_digest": "b827b656b536763b57745dcecbb67860",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3952160,
            "upload_time": "2022-09-07T16:33:35",
            "upload_time_iso_8601": "2022-09-07T16:33:35.132090Z",
            "url": "https://files.pythonhosted.org/packages/ff/51/f280d288d4f3f7e2306e20637adf7e0fdc65ebdc4a4443f66a6d7b9a9204/cargo_xwin-0.10.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "5716e2fdc7206a52eda87fc63f25c05e",
                "sha256": "45b267f5d800e48bd322afde632120414ec8d03662df81fa7bd0d4ba76c7c000"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
            "has_sig": false,
            "md5_digest": "5716e2fdc7206a52eda87fc63f25c05e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3999088,
            "upload_time": "2022-09-07T16:33:37",
            "upload_time_iso_8601": "2022-09-07T16:33:37.392868Z",
            "url": "https://files.pythonhosted.org/packages/37/08/2331707eee0cd1f7172b4b3749c343b57c24b226060c64885b970cdc1e3e/cargo_xwin-0.10.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "b01b8acc1c99d44980c6a5094e2a5b4a",
                "sha256": "b8217ee3de958c45d513f532a687a3a19357eb1add0c6c4c6ac583facef959aa"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-manylinux_2_5_i686.manylinux1_i686.whl",
            "has_sig": false,
            "md5_digest": "b01b8acc1c99d44980c6a5094e2a5b4a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4219497,
            "upload_time": "2022-09-07T16:33:39",
            "upload_time_iso_8601": "2022-09-07T16:33:39.207461Z",
            "url": "https://files.pythonhosted.org/packages/66/cd/7b37aad4d6c8cc4c132e021e9aee00650968bf6baec9b9eb82592efa52b2/cargo_xwin-0.10.4-py3-none-manylinux_2_5_i686.manylinux1_i686.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "13e2edf513cd78feba1eb81143e59916",
                "sha256": "4625e6d1281b1dd52773e1e073d187a7cbb36bf0d089cdb6787e79423bfd9661"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
            "has_sig": false,
            "md5_digest": "13e2edf513cd78feba1eb81143e59916",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4144651,
            "upload_time": "2022-09-07T16:33:41",
            "upload_time_iso_8601": "2022-09-07T16:33:41.008246Z",
            "url": "https://files.pythonhosted.org/packages/79/ff/3b1c161648cd333bc4deecddea5f61310b8efce24f72a7b0bc5ea23f4d22/cargo_xwin-0.10.4-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "53a1744c36d5edc7db3c51f96539f6e6",
                "sha256": "5971e10f733552f354e12acf6a6edd0f23e2330e746fdd1273beb6b803d2e3f8"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-win32.whl",
            "has_sig": false,
            "md5_digest": "53a1744c36d5edc7db3c51f96539f6e6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2238700,
            "upload_time": "2022-09-07T16:33:42",
            "upload_time_iso_8601": "2022-09-07T16:33:42.647449Z",
            "url": "https://files.pythonhosted.org/packages/db/cf/56d239bff1f98ff0d7d62cacafefdb5c34f1e586fee280ab7a515018eea1/cargo_xwin-0.10.4-py3-none-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "ae8b145eecf3969a7cecad02b4e53a87",
                "sha256": "e76116bc3481f9e584e8b21c1d0e08e47b5fc97bedb10628953e62e8db85557a"
            },
            "downloads": -1,
            "filename": "cargo_xwin-0.10.4-py3-none-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "ae8b145eecf3969a7cecad02b4e53a87",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2388288,
            "upload_time": "2022-09-07T16:33:44",
            "upload_time_iso_8601": "2022-09-07T16:33:44.374244Z",
            "url": "https://files.pythonhosted.org/packages/36/d7/21013ff7fbf475d977953b3364df19919058a60386211963e3b7730205d8/cargo_xwin-0.10.4-py3-none-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-09-07 16:33:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "cargo-xwin"
}
        
Elapsed time: 0.41448s