toml-adapt
A very simple Command-line interface for manipulating toml files.
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
A very simple Command-line interface for manipulating toml files.
Basic Info
Statistics
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 3
- Releases: 24
Topics
Metadata Files
README.md
toml-adapt
A simple command-line interface (CLI) for manipulating toml files
🚀 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:
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
🔑 License
This package is distributed under the MIT License. This license can be found online at http://www.opensource.org/licenses/MIT.
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):
Iztok Fister Jr. 💻 📦 💡 🤔 🧑🏫 📖 |
StrajnarFilip 💻 ⚠️ 🤔 💡 |
Ben Beasley 📖 📦 |
Tomasz Kłoczko 🐛 |
Oromion 📦 |
Tadej Lahovnik 📖 ✅ |
This project follows the all-contributors specification. Contributions of any kind welcome!
Owner
- Name: Iztok Fister Jr.
- Login: firefly-cpp
- Kind: user
- Location: Slovenia
- Website: http://www.iztok-jr-fister.eu/
- Repositories: 28
- Profile: https://github.com/firefly-cpp
Citation (CITATION.cff)
authors: - family-names: Fister, Jr. given-names: Iztok orcid: 0000-0002-6418-1272 - family-names: Strajnar given-names: Filip - family-names: Beasley given-names: Ben cff-version: 1.2.0 date-released: '2024-01-07' doi: 10.5281/zenodo.10467167 license: - mit repository-code: https://github.com/firefly-cpp/toml-adapt/tree/0.3.1 title: 'firefly-cpp/toml-adapt: 0.3.1' type: software version: 0.3.1
GitHub Events
Total
- Create event: 3
- Release event: 1
- Issues event: 1
- Watch event: 1
- Delete event: 1
- Issue comment event: 1
- Push event: 3
- Pull request event: 2
Last Year
- Create event: 3
- Release event: 1
- Issues event: 1
- Watch event: 1
- Delete event: 1
- Issue comment event: 1
- Push event: 3
- Pull request event: 2
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| firefly-cpp | i****k@i****u | 72 |
| allcontributors[bot] | 4****] | 18 |
| Filip Strajnar | f****r@g****m | 17 |
| Tadej Lahovnik | t****k@s****i | 5 |
| Benjamin A. Beasley | c****e@m****t | 4 |
| dependabot[bot] | 4****] | 3 |
| Carlos Aznarán Laos | c****l@u****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 15
- Total pull requests: 38
- Average time to close issues: 27 days
- Average time to close pull requests: 3 days
- Total issue authors: 2
- Total pull request authors: 7
- Average comments per issue: 2.13
- Average comments per pull request: 0.5
- Merged pull requests: 34
- Bot issues: 0
- Bot pull requests: 20
Past Year
- Issues: 0
- Pull requests: 7
- Average time to close issues: N/A
- Average time to close pull requests: 25 days
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 5
Top Authors
Issue Authors
- firefly-cpp (13)
- kloczek (2)
Pull Request Authors
- dependabot[bot] (11)
- allcontributors[bot] (9)
- StrajnarFilip (7)
- lahovniktadej (5)
- musicinmybrain (4)
- firefly-cpp (1)
- carlosal1015 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 21
-
Total downloads:
- pypi 75 last-month
- Total docker downloads: 34
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 65
- Total maintainers: 2
alpine-v3.18: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.11-r1
published over 2 years ago
Rankings
Maintainers (1)
alpine-v3.18: toml-adapt-pyc
Precompiled Python bytecode for toml-adapt
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.11-r1
published over 2 years ago
Rankings
Maintainers (1)
alpine-v3.18: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.11-r1
published over 2 years ago
Rankings
Maintainers (1)
pypi.org: toml-adapt
A simple command-line interface for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- Documentation: https://toml-adapt.readthedocs.io/en/latest/
- License: MIT
-
Latest release: 0.3.4
published 11 months ago
Rankings
Maintainers (1)
alpine-edge: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.4-r0
published 11 months ago
Rankings
Maintainers (1)
alpine-edge: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.4-r0
published 11 months ago
Rankings
Maintainers (1)
alpine-edge: toml-adapt-pyc
Precompiled Python bytecode for toml-adapt
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.4-r0
published 11 months ago
Rankings
Maintainers (1)
alpine-v3.17: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.10-r0
published about 3 years ago
Rankings
Maintainers (1)
alpine-v3.17: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.10-r0
published about 3 years ago
Rankings
Maintainers (1)
alpine-v3.19: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.12-r0
published about 2 years ago
Rankings
Maintainers (1)
alpine-v3.19: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.12-r0
published about 2 years ago
Rankings
Maintainers (1)
alpine-v3.20: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.3-r1
published over 1 year ago
Rankings
Maintainers (1)
alpine-v3.22: toml-adapt-pyc
Precompiled Python bytecode for toml-adapt
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.4-r0
published 11 months ago
Rankings
Maintainers (1)
alpine-v3.20: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.3-r1
published over 1 year ago
Rankings
Maintainers (1)
alpine-v3.22: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.4-r0
published 11 months ago
Rankings
Maintainers (1)
alpine-v3.20: toml-adapt-pyc
Precompiled Python bytecode for toml-adapt
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.3-r1
published over 1 year ago
Rankings
Maintainers (1)
alpine-v3.22: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.4-r0
published 11 months ago
Rankings
Maintainers (1)
alpine-v3.21: toml-adapt-doc
A simple command-line interface (CLI) for manipulating toml files (documentation)
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.3-r1
published over 1 year ago
Rankings
Maintainers (1)
alpine-v3.21: toml-adapt
A simple command-line interface (CLI) for manipulating toml files
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.3-r1
published over 1 year ago
Rankings
Maintainers (1)
alpine-v3.19: toml-adapt-pyc
Precompiled Python bytecode for toml-adapt
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.2.12-r0
published about 2 years ago
Rankings
alpine-v3.21: toml-adapt-pyc
Precompiled Python bytecode for toml-adapt
- Homepage: https://github.com/firefly-cpp/toml-adapt
- License: MIT
-
Latest release: 0.3.3-r1
published over 1 year ago