poetbricks

Name	poetbricks JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	A little CLI tool to create requirements.txt file that are compatible with databricks. The produced requirement file can be uploaded to databricks to set up any custom compute.
upload_time	2024-10-17 08:55:30
maintainer	None
docs_url	None
author	Lars Vögtlin
requires_python	>=3.11
license	GPL-3.0-or-later
keywords	poetry databricks requirement pip
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # poetbricks
A CLI tool to create requirements files that are compatible with databricks from the peorty section of the pypjroject.toml file.

## Requirements
- python >= 3.10
- requests >= 2.32.2

### Testing requirements
- request-mock >= 1.12.1
- pytest-mock >=3.14.0
- pytest >= 8.3.3

## Installation
We recommand to use pipx to install the package as follows:
```
pipx install poetbricks
```

But its also possible to use pip:

```
pip install poetbricks
```
## Usage
Run the `poetbricks` command inside of your `poetry` project. You need to provede the `-v` Databricks vmimage version. `poetbricks` will look for the `pyproject.toml` file in the current working directory if the argument `-i` is not set (pointing to the folder containig the `pyproject.toml` file). 

### Example
Create the `requirement.txt` file based on the Databricks 15.3 vmimage version and the pyproject toml.

```
poetbricks -v 15.3 -i . -w
```
The `-w` prevents `poetbricks` to override a `requirements.txt` file in `-i`.

### Running Tests
To run the tests use `poetry` to install all needed dependencies and run the tests.
``` 
poetry run pytest -v
```

## Contribute
If you find any problems or have feature requests create an issue or a PR.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "poetbricks",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "poetry, databricks, requirement, pip",
    "author": "Lars V\u00f6gtlin",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ce/7b/f3c4c3350f35db7066bb1cad0e98ef8efa73075621a1d4a0f67e800e0a68/poetbricks-0.1.2.tar.gz",
    "platform": null,
    "description": "# poetbricks\nA CLI tool to create requirements files that are compatible with databricks from the peorty section of the pypjroject.toml file.\n\n## Requirements\n- python >= 3.10\n- requests >= 2.32.2\n\n### Testing requirements\n- request-mock >= 1.12.1\n- pytest-mock >=3.14.0\n- pytest >= 8.3.3\n\n## Installation\nWe recommand to use pipx to install the package as follows:\n```\npipx install poetbricks\n```\n\nBut its also possible to use pip:\n\n```\npip install poetbricks\n```\n## Usage\nRun the `poetbricks` command inside of your `poetry` project. You need to provede the `-v` Databricks vmimage version. `poetbricks` will look for the `pyproject.toml` file in the current working directory if the argument `-i` is not set (pointing to the folder containig the `pyproject.toml` file). \n\n### Example\nCreate the `requirement.txt` file based on the Databricks 15.3 vmimage version and the pyproject toml.\n\n```\npoetbricks -v 15.3 -i . -w\n```\nThe `-w` prevents `poetbricks` to override a `requirements.txt` file in `-i`.\n\n### Running Tests\nTo run the tests use `poetry` to install all needed dependencies and run the tests.\n``` \npoetry run pytest -v\n```\n\n## Contribute\nIf you find any problems or have feature requests create an issue or a PR.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A little CLI tool to create requirements.txt file that are compatible with databricks. The produced requirement file can be uploaded to databricks to set up any custom compute.",
    "version": "0.1.2",
    "project_urls": null,
    "split_keywords": [
        "poetry",
        " databricks",
        " requirement",
        " pip"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5eef2fd69b9b948affc04b78f0f4e0ea121d639bdc3d672ca52aa86108c4d5d5",
                "md5": "3c861a1d634df9c7f2d51dce631ed342",
                "sha256": "dd73cc69d81ad5c21e9baf1bdd70d0359f94a1fb0042aaf0952097614a821e9c"
            },
            "downloads": -1,
            "filename": "poetbricks-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3c861a1d634df9c7f2d51dce631ed342",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 15986,
            "upload_time": "2024-10-17T08:55:29",
            "upload_time_iso_8601": "2024-10-17T08:55:29.456519Z",
            "url": "https://files.pythonhosted.org/packages/5e/ef/2fd69b9b948affc04b78f0f4e0ea121d639bdc3d672ca52aa86108c4d5d5/poetbricks-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce7bf3c4c3350f35db7066bb1cad0e98ef8efa73075621a1d4a0f67e800e0a68",
                "md5": "533c6de1e0bab03915a4aade92470650",
                "sha256": "6274746afc15d4db8fade9023d3f936de9a2db726d56e64991ba8b2e30b0fe9b"
            },
            "downloads": -1,
            "filename": "poetbricks-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "533c6de1e0bab03915a4aade92470650",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 15285,
            "upload_time": "2024-10-17T08:55:30",
            "upload_time_iso_8601": "2024-10-17T08:55:30.986155Z",
            "url": "https://files.pythonhosted.org/packages/ce/7b/f3c4c3350f35db7066bb1cad0e98ef8efa73075621a1d4a0f67e800e0a68/poetbricks-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-17 08:55:30",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "poetbricks"
}