| Name | openfund-core JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-11-26 06:27:48 |
| maintainer | None |
| docs_url | None |
| author | yang99love |
| requires_python | <4.0,>=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Openfund Core
[](https://python-poetry.org/)
[](https://pypi.org/project/poetry-core/)
[](https://pypi.org/project/poetry-core/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/python-poetry/poetry-core/actions?query=workflow%3ATests)
A [PEP 517](https://www.python.org/dev/peps/pep-0517/) build backend implementation developed for
[Poetry](https://github.com/python-poetry/poetry). This project is intended to be a lightweight, fully compliant,
self-contained package allowing PEP 517-compatible build frontends to build Poetry-managed projects.
## Usage
In most cases, the usage of this package is transparent to the end-user as it is either used by Poetry itself
or a PEP 517 frontend (eg: `pip`).
In order to enable the use of `openfund-core` as your build backend, the following snippet must be present in your
project's `pyproject.toml` file.
```toml
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
```
Once this is present, a PEP 517 frontend like `pip` can build and install your project from source without the need
for Poetry or any of its dependencies (besides `openfund-core`).
```shell
# install to current environment
pip install /path/to/poetry/managed/project
# build a wheel package
pip wheel /path/to/poetry/managed/project
```
## Why is this required?
Prior to the release of version `1.1.0`, Poetry was a project management tool that included a PEP 517
build backend. This was inefficient and time consuming when a PEP 517 build was required. For example,
both `pip` and `tox` (with isolated builds) would install Poetry and all dependencies it required. Most of these
dependencies are not required when the objective is to simply build either a source or binary distribution of your
project.
In order to improve the above situation, `openfund-core` was created. Shared functionality pertaining to PEP 517 build
backends, including reading `pyproject.toml` and building wheel/sdist, were implemented in this package. This
makes PEP 517 builds extremely fast for Poetry-managed packages.
Raw data
{
"_id": null,
"home_page": null,
"name": "openfund-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "yang99love",
"author_email": "yang99love@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/5c/d8/9f1c064d937e9964660b4547ab92c303eb26f0ccaff29cff77ddfadda7ea/openfund_core-0.0.4.tar.gz",
"platform": null,
"description": "# Openfund Core\n[](https://python-poetry.org/)\n[](https://pypi.org/project/poetry-core/)\n[](https://pypi.org/project/poetry-core/)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/python-poetry/poetry-core/actions?query=workflow%3ATests)\n\nA [PEP 517](https://www.python.org/dev/peps/pep-0517/) build backend implementation developed for\n[Poetry](https://github.com/python-poetry/poetry). This project is intended to be a lightweight, fully compliant,\nself-contained package allowing PEP 517-compatible build frontends to build Poetry-managed projects.\n\n## Usage\nIn most cases, the usage of this package is transparent to the end-user as it is either used by Poetry itself\nor a PEP 517 frontend (eg: `pip`).\n\nIn order to enable the use of `openfund-core` as your build backend, the following snippet must be present in your\nproject's `pyproject.toml` file.\n\n```toml\n[build-system]\nrequires = [\"poetry-core\"]\nbuild-backend = \"poetry.core.masonry.api\"\n```\n\nOnce this is present, a PEP 517 frontend like `pip` can build and install your project from source without the need\nfor Poetry or any of its dependencies (besides `openfund-core`).\n\n```shell\n# install to current environment\npip install /path/to/poetry/managed/project\n\n# build a wheel package\npip wheel /path/to/poetry/managed/project\n```\n\n## Why is this required?\nPrior to the release of version `1.1.0`, Poetry was a project management tool that included a PEP 517\nbuild backend. This was inefficient and time consuming when a PEP 517 build was required. For example,\nboth `pip` and `tox` (with isolated builds) would install Poetry and all dependencies it required. Most of these\ndependencies are not required when the objective is to simply build either a source or binary distribution of your\nproject.\n\nIn order to improve the above situation, `openfund-core` was created. Shared functionality pertaining to PEP 517 build\nbackends, including reading `pyproject.toml` and building wheel/sdist, were implemented in this package. This\nmakes PEP 517 builds extremely fast for Poetry-managed packages.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c25302d321e233dc816d321a201e2270a21f6e22fe2e970274287a0665048098",
"md5": "dac6016be64977d6a5f2428b264a6e45",
"sha256": "a2c2605258cdde9c6f55fa1fffdc154d2225799ab41331b25ab2b853f4c4878c"
},
"downloads": -1,
"filename": "openfund_core-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dac6016be64977d6a5f2428b264a6e45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 37354,
"upload_time": "2024-11-26T06:27:46",
"upload_time_iso_8601": "2024-11-26T06:27:46.685210Z",
"url": "https://files.pythonhosted.org/packages/c2/53/02d321e233dc816d321a201e2270a21f6e22fe2e970274287a0665048098/openfund_core-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5cd89f1c064d937e9964660b4547ab92c303eb26f0ccaff29cff77ddfadda7ea",
"md5": "50315adcfaccba6c5f1bd5cf29fc0278",
"sha256": "2e3e10f9eed07a6af9fe801d8713a6f84b235f413c6dcfdf6181bbe257062ea5"
},
"downloads": -1,
"filename": "openfund_core-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "50315adcfaccba6c5f1bd5cf29fc0278",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 23473,
"upload_time": "2024-11-26T06:27:48",
"upload_time_iso_8601": "2024-11-26T06:27:48.592811Z",
"url": "https://files.pythonhosted.org/packages/5c/d8/9f1c064d937e9964660b4547ab92c303eb26f0ccaff29cff77ddfadda7ea/openfund_core-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 06:27:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openfund-core"
}
