poetry-brew


Namepoetry-brew JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/celsiusnarhwal/poetry-brew
SummaryGenerate Homebrew formulae for Poetry projects
upload_time2023-03-12 14:16:16
maintainer
docs_urlNone
authorcelsius narhwal
requires_python>=3.10,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # poetry-brew

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/poetry-brew?logo=python&logoColor=white&style=for-the-badge)](https://pypi.org/project/poetry-brew)
[![PyPI](https://img.shields.io/pypi/v/poetry-brew?logo=pypi&color=green&logoColor=white&style=for-the-badge)](https://pypi.org/project/poetry-brew)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/celsiusnarhwal/poetry-brew?logo=github&color=orange&logoColor=white&style=for-the-badge)](https://github.com/celsiusnarhwal/poetry-brew/releases)
[![PyPI - License](https://img.shields.io/pypi/l/poetry-brew?color=03cb98&style=for-the-badge)](https://github.com/celsiusnarhwal/poetry-brew/blob/main/LICENSE.md)

poetry-brew is a [Poetry](https://python-poetry.org/) plugin that generates Homebrew formulae for Poetry projects.

## Installation

```bash
poetry self add poetry-brew
```
## Requirements

poetry-brew can only generate formulae for packages that meet the following criteria:

- The package must be published on PyPI.
- `pyproject.toml` and `poetry.lock` must be present in the directory where `poetry brew` is run.
- `pyproject.toml` must specify values for `tool.poetry.name`, `tool.poetry.version`,
  and `tool.poetry.dependencies.python`.
    - `tool.poetry.name` must be a case-insensitive match with the package's name on PyPI.
    - `tool.poetry.version` must match a version of the package that has been published on PyPI.
     For full usage information, run `poetry brew --help`.

## Usage

```bash
poetry brew
```

`poetry brew` supports the `--with`, `--without`, and `--only` options, which function identically to `poetry install`.
For full usage information, run `poetry brew --help`.

## Configuration

poetry-brew can be configured through a `tool.brew.config` section in `pyproject.toml`.

```toml
[tool.brew.config]
dependencies = []
```

### Supported Options

- `dependencies` (`list`, default: `[]`): A list of other Homebrew formulae the package depends on.

## License

poetry-brew is licensed under the [MIT License](https://github.com/celsiusnarhwal/poetry-brew/blob/main/LICENSE.md).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/celsiusnarhwal/poetry-brew",
    "name": "poetry-brew",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "celsius narhwal",
    "author_email": "hello@celsiusnarhwal.dev",
    "download_url": "https://files.pythonhosted.org/packages/45/db/bcf5449c62e47a46fa3bdcda1e425663e661ade6ca2c151f5bc83edd90dd/poetry_brew-1.0.3.tar.gz",
    "platform": null,
    "description": "# poetry-brew\n\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/poetry-brew?logo=python&logoColor=white&style=for-the-badge)](https://pypi.org/project/poetry-brew)\n[![PyPI](https://img.shields.io/pypi/v/poetry-brew?logo=pypi&color=green&logoColor=white&style=for-the-badge)](https://pypi.org/project/poetry-brew)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/celsiusnarhwal/poetry-brew?logo=github&color=orange&logoColor=white&style=for-the-badge)](https://github.com/celsiusnarhwal/poetry-brew/releases)\n[![PyPI - License](https://img.shields.io/pypi/l/poetry-brew?color=03cb98&style=for-the-badge)](https://github.com/celsiusnarhwal/poetry-brew/blob/main/LICENSE.md)\n\npoetry-brew is a [Poetry](https://python-poetry.org/) plugin that generates Homebrew formulae for Poetry projects.\n\n## Installation\n\n```bash\npoetry self add poetry-brew\n```\n## Requirements\n\npoetry-brew can only generate formulae for packages that meet the following criteria:\n\n- The package must be published on PyPI.\n- `pyproject.toml` and `poetry.lock` must be present in the directory where `poetry brew` is run.\n- `pyproject.toml` must specify values for `tool.poetry.name`, `tool.poetry.version`,\n  and `tool.poetry.dependencies.python`.\n    - `tool.poetry.name` must be a case-insensitive match with the package's name on PyPI.\n    - `tool.poetry.version` must match a version of the package that has been published on PyPI.\n     For full usage information, run `poetry brew --help`.\n\n## Usage\n\n```bash\npoetry brew\n```\n\n`poetry brew` supports the `--with`, `--without`, and `--only` options, which function identically to `poetry install`.\nFor full usage information, run `poetry brew --help`.\n\n## Configuration\n\npoetry-brew can be configured through a `tool.brew.config` section in `pyproject.toml`.\n\n```toml\n[tool.brew.config]\ndependencies = []\n```\n\n### Supported Options\n\n- `dependencies` (`list`, default: `[]`): A list of other Homebrew formulae the package depends on.\n\n## License\n\npoetry-brew is licensed under the [MIT License](https://github.com/celsiusnarhwal/poetry-brew/blob/main/LICENSE.md).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Generate Homebrew formulae for Poetry projects",
    "version": "1.0.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "10883f3cd64aa9adddd71439b21222b5c3dd939fa7a975c6ea29b7560de81347",
                "md5": "2d153b8009d3887a45d63d2a6115db34",
                "sha256": "e343e00272fcd9a873a4bd2ea8ff0444d6b962bef6167b696c8d58380f891d6f"
            },
            "downloads": -1,
            "filename": "poetry_brew-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d153b8009d3887a45d63d2a6115db34",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 5542,
            "upload_time": "2023-03-12T14:16:15",
            "upload_time_iso_8601": "2023-03-12T14:16:15.197268Z",
            "url": "https://files.pythonhosted.org/packages/10/88/3f3cd64aa9adddd71439b21222b5c3dd939fa7a975c6ea29b7560de81347/poetry_brew-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45dbbcf5449c62e47a46fa3bdcda1e425663e661ade6ca2c151f5bc83edd90dd",
                "md5": "1ba3f4de90693057b7240104ca2f2cef",
                "sha256": "4348ab393ec8ac224c4a60402b4813bf99f87aae7c1cdf2cadb883dae59e5179"
            },
            "downloads": -1,
            "filename": "poetry_brew-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "1ba3f4de90693057b7240104ca2f2cef",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 4815,
            "upload_time": "2023-03-12T14:16:16",
            "upload_time_iso_8601": "2023-03-12T14:16:16.727668Z",
            "url": "https://files.pythonhosted.org/packages/45/db/bcf5449c62e47a46fa3bdcda1e425663e661ade6ca2c151f5bc83edd90dd/poetry_brew-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-12 14:16:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "celsiusnarhwal",
    "github_project": "poetry-brew",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "poetry-brew"
}
        
Elapsed time: 0.04172s