Skip to content

educationwarehouse/edwh-pipcompile-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

edwh-pipcompile-plugin

PyPI - Version PyPI - Python Version


Table of Contents

Installation

pip install edwh-pipcompile-plugin

But probably you want to install the whole edwh package:

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:

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 <myfile.in>. This will result in a myfile.txt. You can run it on a directory: ew pip.compile <mydirectory> 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 <directory>/requirements.txt).

If you want to modify this behavior, you can do so via pyproject.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 license.

Changelog

See CHANGELOG.md