1TOML-ADAPT(1)                    User Commands                   TOML-ADAPT(1)
2
3
4

NAME

6       toml-adapt - adapt toml files
7

SYNOPSIS

9       toml-adapt [--help] [-path TEXT] [-path TEXT] [-dep TEXT] [-ver TEXT]
10

DESCRIPTION

12       Working with TOML files is becoming inevitable during the package main‐
13       tenance process in different ecosystems.  Many times package  maintain‐
14       ers  must  either change the version of dependency or add/remove depen‐
15       dencies when building their packages, due to the inconsistent base sys‐
16       tem.   For  example, solving this issue can be done either by using the
17       provided patches or using sed commands.  However, this may be  slightly
18       time-consuming and irritating.  A very simple yet user-friendly command
19       line interface was developed in order to make this process easier.
20
21   FEATURES
22       CLI currently supports the following operations:
23
24       •   adding/removing dependencies
25
26       •   changing the  dependency version
27
28       •   changing the dependency versions of all packages concurrently
29
30       •   adding/removing/changing dev dependencies
31
32   SUPPORTED PACKAGING TOOLS
33       The following packaging tools are currently supported by this software:
34
35       •   poetry
36
37       •   flit
38
39       •   cargo
40
41       •   julia (partly)
42

OPTIONS

44       --help Show a help message and exit.
45
46       -path TEXT
47              Specifies the path to the TOML file  you  wish  to  edit.   [re‐
48              quired]
49
50       -a TEXT
51              Action.  Any of the following: add, remove, change, add-dev, re‐
52              move-dev, change-dev.  [required]
53
54       -dep TEXT
55              This option sets the name of dependency you wish to  manipulate.
56              Reserved keyword ALL will instead do action on all dependencies.
57              [required]
58
59       -ver TEXT
60              This option sets the version.  With Python Poetry, there is  re‐
61              served  keyword  X,  which will become * (meaning it accepts any
62              version of dependency).
63

EXAMPLES

65       Change dependency
66
67              toml-adapt -path pyproject.toml -a change -dep niaclass -ver 0.1.0
68
69       Add dependency
70
71              toml-adapt -path pyproject.toml -a add -dep niaclass -ver 0.1.0
72
73       Remove dependency
74
75              toml-adapt -path pyproject.toml -a remove -dep niaclass -ver 0.1.0
76
77   OTHER EXAMPLES
78       Change all existing dependencies in toml file
79
80              toml-adapt -path pyproject.toml -a change -dep ALL -ver X
81              X represents a *
82
83   HOW TO USE IT IN SPEC FILES?
84              %prep
85              ...
86              # Make dependencies consistent with Fedora dependencies
87              toml-adapt -path pyproject.toml -a change -dep ALL -ver X
88
89
90
91                                   June 2021                     TOML-ADAPT(1)
Impressum