https://github.com/firefly-cpp/toml-adapt

A very simple Command-line interface for manipulating toml files.
https://github.com/firefly-cpp/toml-adapt

toml

Last synced: 6 days ago
JSON representation

A very simple Command-line interface for manipulating toml files.

Host: GitHub
URL: https://github.com/firefly-cpp/toml-adapt
Owner: firefly-cpp
License: mit
Created: 2021-05-30T17:08:23.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2025-03-06T05:00:17.000Z (4 months ago)
Last Synced: 2025-05-13T14:20:56.974Z (about 1 month ago)
Topics: toml
Language: Python
Homepage:
Size: 212 KB
Stars: 4
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Authors: AUTHORS.rst

Awesome Lists containing this project

README

toml-adapt

A simple command-line interface (CLI) for manipulating toml files

PyPI - Python Version
PyPI - Downloads

GitHub commit activity

🚀 Features •
🛠️ Supported packaging tools •
📦 Installation •
🚀 Usage •
📄 Cite us •
🔑 License •
✨ Contributors

Working with TOML files is becoming inevitable during the package maintenance process in different ecosystems. 🌐 Many times package maintainers must either change the version of dependency or add/remove dependencies when building their packages, due to the inconsistent base system. For example, solving this issue can be done either by using the provided patches or using sed commands. However, this may be slightly time-consuming and irritating. ⏳ A very simple yet user-friendly command line interface was developed in order to make this process easier. ⚙️📄🛠️

* **Free software:** MIT license
* **Python versions:** 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
* **Documentation:** https://toml-adapt.readthedocs.io/en/latest
* **Tested OS:** Windows, Ubuntu, Debian, Fedora, Alpine, Arch, macOS. **However, that does not mean it does not work on others.**

## 🚀 Features

CLI currently supports the following operations:

- adding/removing dependencies
- changing the dependency version
- changing the dependency versions of all packages concurrently
- adding/removing/changing dev dependencies

## 🛠️ Supported packaging tools

The following packaging tools are currently supported by this software:

- poetry
- flit
- cargo
- julia (partly)

## 📦 Installation

### pip3

To install `toml-adapt` with pip, use:

```sh
pip install toml-adapt
```

### Fedora Linux

To install `toml-adapt` on Fedora, use:

```sh
$ dnf install python-toml-adapt
```

### Alpine Linux

To install `toml-adapt` on Alpine Linux, use:

```sh
$ apk add toml-adapt
```

### Arch Linux

To install `toml-adapt` on Arch Linux, use an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers):

```sh
$ yay -Syyu toml-adapt
```

## 🚀 Usage

`-a` Available actions are:
- add
- remove
- change
- add-dev
- remove-dev
- change-dev

`-path` Specifies the path to the TOML file you wish to edit.

`-dep` This option sets the name of dependency you wish to manipulate. Reserved keyword `ALL` will instead do action on all dependencies.

`-ver` This option sets the version. With Python Poetry, there is reserved keyword `X`, which will become `*` (meaning it accepts any version of dependency).

The following are examples of usage:

### Change dependency
```sh
toml-adapt -path pyproject.toml -a change -dep niaclass -ver 0.1.0
```

### Add dependency
```sh
toml-adapt -path pyproject.toml -a add -dep niaclass -ver 0.1.0
```

### Remove dependency
```sh
toml-adapt -path pyproject.toml -a remove -dep niaclass -ver 0.1.0
```

### Other examples

Change all existing dependencies in toml file
```sh
toml-adapt -path pyproject.toml -a change -dep ALL -ver X
```
X represents a *

### How to use it in SPEC files?

```sh
%prep
...

## Make dependencies consistent with Fedora dependencies

toml-adapt -path pyproject.toml -a change -dep ALL -ver X
```

## 📄 Cite us

Fister, Jr., I., & Strajnar, F. (2024). firefly-cpp/toml-adapt: 0.3.1 (0.3.1). Zenodo. [https://doi.org/10.5281/zenodo.10467167](https://doi.org/10.5281/zenodo.10467167)

## 🔑 License

This package is distributed under the MIT License. This license can be found online at .

## Disclaimer

This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!

## ✨ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Iztok Fister Jr.}
💻 📦 💡 🤔 🧑‍🏫 📖

_{StrajnarFilip}
💻 ⚠️ 🤔 💡

_{Ben Beasley}
📖 📦

_{Tomasz Kłoczko}
🐛

_Oromion
📦

_{Tadej Lahovnik}
📖 ✅