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 year 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 (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T16:58:20.000Z (over 1 year ago)
- Last Synced: 2025-03-15T22:17:16.911Z (about 1 year ago)
- Topics: edwh, invoke, pip, python
- Language: Python
- Homepage: https://pypi.org/project/edwh-pipcompile-plugin/
- Size: 102 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
[](https://pypi.org/project/edwh-pipcompile-plugin)
[](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)