https://github.com/educationwarehouse/edwh-pipcompile-plugin

Plugin that integrates `pip-tools` with `edwh`
https://github.com/educationwarehouse/edwh-pipcompile-plugin

edwh invoke pip python

Last synced: about 1 month ago
JSON representation

Plugin that integrates `pip-tools` with `edwh`

• Host: GitHub
• URL: https://github.com/educationwarehouse/edwh-pipcompile-plugin
• Owner: educationwarehouse
• License: mit
• Created: 2023-04-11T10:45:41.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-15T10:24:59.000Z (11 months ago)
• Last Synced: 2024-12-11T16:46:16.183Z (about 2 months ago)
• Topics: edwh, invoke, pip, python
• Language: Python
• Homepage: https://pypi.org/project/edwh-pipcompile-plugin/
• Size: 92.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# edwh-pipcompile-plugin

[![PyPI - Version](https://img.shields.io/pypi/v/edwh-pipcompile-plugin.svg)](https://pypi.org/project/edwh-pipcompile-plugin)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/edwh-pipcompile-plugin.svg)](https://pypi.org/project/edwh-pipcompile-plugin)

-----

**Table of Contents**

- [Installation](#installation)

- [License](#license)

- [Changelog](#changelog)

## Installation

```console

pip install edwh-pipcompile-plugin

```

But probably you want to install the whole edwh package:

```console

pipx install edwh[pip]

# or

pipx install edwh[plugins,omgeving]

```

## Usage

To see all available subcommands or get help for a specific command, you can use:

```bash

edwh help pip

edwh help pip.compile

```

You can use `pip.compile` (and `pip.upgrade`, etc.) in multiple ways.

You can run it on a specific file: `ew pip.compile `. This will result in a `myfile.txt`.

You can run it on a directory: `ew pip.compile ` or `ew pip.compile .`.

This will transform all `.in` files into `.out` files (with the same name):

- `mydirectory/first.in` -> `mydirectory/first.txt`

- `mydirectory/second.in` -> `mydirectory/second.txt`

You can also add `--combine` to combine multiple `.in` files into a single `.txt` file (

called `/requirements.txt`).

If you want to modify this behavior, you can do so via `pyproject.toml`:

```toml

[tool.edwh.pipcompile.directory]

input = ["first.in", "../second.in"] # will ignore other .in files;

# transformed to directory/first.in and ./second.in

output = "output.txt" # directory/output.txt

```

Where 'directory' is the name of a specific folder. 

You can use the special symbol `__cwd__` to target the project folder.

## License

`edwh-pipcompile-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Changelog

[See CHANGELOG.md](CHANGELOG.md)