Metadata-Version: 2.1
Name: poetbricks
Version: 0.1.2
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.
License: GPL-3.0-or-later
Keywords: poetry,databricks,requirement,pip
Author: Lars Vögtlin
Requires-Python: >=3.11
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: requests (>=2.32.3,<3.0.0)
Description-Content-Type: text/markdown

# 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.

