| Name | scikit-build-core-conan JSON |
| Version |
0.5.3
JSON |
| download |
| home_page | None |
| Summary | A conan plugin for scikit-build-core |
| upload_time | 2024-12-18 21:38:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# scikit-build-core-conan
A conan plugin for scikit-build-core
> [!NOTE]
> This project is under early development. Should you encounter any problems, please feel free to open an issue.
## Installation
```shell
pip install scikit-build-core-conan
```
To use `scikit-build-core-conan`, add it to your `build-system.requires`, and specify
the `scikit_build_core_conan.build` builder as your `build-system.build-backend`. You do not need to
specify `scikit_build_core` as it will be required automatically.
## Project Example
Here's a simple example on how you can use `scikit-build-core-conan` in your `pyproject.toml`.
```toml
[build-system]
requires = ["scikit-build-core-conan"]
build-backend = "scikit_build_core_conan.build"
[project]
name = "scikit_build_conan_simplest"
version = "0.0.1"
```
## Configuration
`scikit-build-core-conan` supports a broad range of configuration options. These options can be placed directly in
the `pyproject.toml` file. They can also be passed via `-C/--config-setting` in build or `-C/--config-settings`
in `pip`. Below are the supported configuration options:
```toml
[tool.scikit-build-core-conan]
path = "."
build = "missing"
profile = "default"
options = []
settings = []
config = []
generator = "Ninja"
output-folder = "build"
```
### Local recipes
Sometimes you may want to consume a local recipe rather than from the conan centre index. You can do this like this:
```toml
[[tool.scikit-build-core-conan.local-recipes]]
path = "path/to/recipe"
name = "recipe" # optional: package name if not specified in conanfile
version = "0.0.1" # optional: package version if not specified in conanfile
```
### Overrides
`scikit-build-core-conan` uses the same override system as `scikit-build-core`. For more details, check out the
[documentation](https://scikit-build-core.readthedocs.io/en/latest/configuration.html#overrides) of `scikit-build-core`.
For example:
```toml
[[tool.scikit-build-core-conan.overrides]]
if.platform-system = "linux"
profile = "/path/to/profile"
```
## Projects using this build backend:
- **[endstone](https://github.com/EndstoneMC/endstone)**: A high-level plugin api for Minecraft: Bedrock Edition Dedicated Servers.
Raw data
{
"_id": null,
"home_page": null,
"name": "scikit-build-core-conan",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Zhengyu Wu <zhengyu.wu21@imperial.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/1d/d4/9bac95d9bb63e1cfbe658481a609346204d883503019ee218d674999bee5/scikit_build_core_conan-0.5.3.tar.gz",
"platform": null,
"description": "# scikit-build-core-conan\n\nA conan plugin for scikit-build-core\n\n> [!NOTE]\n> This project is under early development. Should you encounter any problems, please feel free to open an issue.\n\n## Installation\n\n```shell\npip install scikit-build-core-conan\n```\n\nTo use `scikit-build-core-conan`, add it to your `build-system.requires`, and specify\nthe `scikit_build_core_conan.build` builder as your `build-system.build-backend`. You do not need to\nspecify `scikit_build_core` as it will be required automatically.\n\n## Project Example\n\nHere's a simple example on how you can use `scikit-build-core-conan` in your `pyproject.toml`.\n\n```toml\n\n[build-system]\nrequires = [\"scikit-build-core-conan\"]\nbuild-backend = \"scikit_build_core_conan.build\"\n\n[project]\nname = \"scikit_build_conan_simplest\"\nversion = \"0.0.1\"\n```\n\n## Configuration\n\n`scikit-build-core-conan` supports a broad range of configuration options. These options can be placed directly in\nthe `pyproject.toml` file. They can also be passed via `-C/--config-setting` in build or `-C/--config-settings`\nin `pip`. Below are the supported configuration options:\n\n```toml\n[tool.scikit-build-core-conan]\npath = \".\"\nbuild = \"missing\"\nprofile = \"default\"\noptions = []\nsettings = []\nconfig = []\ngenerator = \"Ninja\"\noutput-folder = \"build\"\n```\n\n### Local recipes\n\nSometimes you may want to consume a local recipe rather than from the conan centre index. You can do this like this:\n```toml\n[[tool.scikit-build-core-conan.local-recipes]]\npath = \"path/to/recipe\"\nname = \"recipe\" # optional: package name if not specified in conanfile\nversion = \"0.0.1\" # optional: package version if not specified in conanfile\n```\n\n### Overrides\n\n`scikit-build-core-conan` uses the same override system as `scikit-build-core`. For more details, check out the\n[documentation](https://scikit-build-core.readthedocs.io/en/latest/configuration.html#overrides) of `scikit-build-core`.\n\nFor example:\n\n```toml\n[[tool.scikit-build-core-conan.overrides]]\nif.platform-system = \"linux\"\nprofile = \"/path/to/profile\"\n```\n\n## Projects using this build backend:\n\n- **[endstone](https://github.com/EndstoneMC/endstone)**: A high-level plugin api for Minecraft: Bedrock Edition Dedicated Servers.\n",
"bugtrack_url": null,
"license": null,
"summary": "A conan plugin for scikit-build-core",
"version": "0.5.3",
"project_urls": {
"Homepage": "https://github.com/wu-vincent/scikit-build-core-conan",
"Issues": "https://github.com/wu-vincent/scikit-build-core-conan/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c270fd5e93a449e5a6c20809588533aaacc0d8c66ba073785d94284445041b0",
"md5": "d554f01698fde563e7208add97d81c63",
"sha256": "af033625887638ffcaa3e12aa82ae798fccb34b089cfdfdc663dc569e447877a"
},
"downloads": -1,
"filename": "scikit_build_core_conan-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d554f01698fde563e7208add97d81c63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6540,
"upload_time": "2024-12-18T21:38:46",
"upload_time_iso_8601": "2024-12-18T21:38:46.872084Z",
"url": "https://files.pythonhosted.org/packages/6c/27/0fd5e93a449e5a6c20809588533aaacc0d8c66ba073785d94284445041b0/scikit_build_core_conan-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1dd49bac95d9bb63e1cfbe658481a609346204d883503019ee218d674999bee5",
"md5": "140d834a76863874a6ebdf6219a0bb33",
"sha256": "07f32c7e58e07b9738d1a4b562d4e5f0b3fb36ebcc88f66b90b9ebffaa17f61a"
},
"downloads": -1,
"filename": "scikit_build_core_conan-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "140d834a76863874a6ebdf6219a0bb33",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6674,
"upload_time": "2024-12-18T21:38:49",
"upload_time_iso_8601": "2024-12-18T21:38:49.327124Z",
"url": "https://files.pythonhosted.org/packages/1d/d4/9bac95d9bb63e1cfbe658481a609346204d883503019ee218d674999bee5/scikit_build_core_conan-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 21:38:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wu-vincent",
"github_project": "scikit-build-core-conan",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scikit-build-core-conan"
}
