https://github.com/facelessuser/bracex
Bash style brace expansion for Python
https://github.com/facelessuser/bracex
Last synced: about 1 year ago
JSON representation
Bash style brace expansion for Python
- Host: GitHub
- URL: https://github.com/facelessuser/bracex
- Owner: facelessuser
- License: mit
- Created: 2018-05-17T06:00:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T23:47:44.000Z (over 1 year ago)
- Last Synced: 2025-03-28T20:07:49.215Z (over 1 year ago)
- Language: Python
- Homepage: https://facelessuser.github.io/bracex/
- Size: 3.08 MB
- Stars: 24
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[![Donate via PayPal][donate-image]][donate-link]
[![Build][github-ci-image]][github-ci-link]
[![Coverage Status][codecov-image]][codecov-link]
[![PyPI Version][pypi-image]][pypi-link]
[![PyPI - Python Version][python-image]][pypi-link]
![License][license-image-mit]
# Bracex
Bracex is a brace expanding library (à la Bash) for Python. Brace expanding is used to generate arbitrary strings.
```console
$ echo {{a,b},c}d
ad bd cd
```
Bracex adds this ability to Python:
```python
>>> bracex.expand(r'file-{{a,b},c}d.txt')
['file-ad.txt', 'file-bd.txt', 'file-cd.txt']
```
and as a command:
```console
$ python3 -m bracex -0 "base/{a,b}/{1..2}" | xargs -0 mkdir -p
$ tree base/
base/
├── a
│ ├── 1
│ └── 2
└── b
├── 1
└── 2
```
- **Why Bracex over other solutions?**
Bracex actually follows pretty closely to how Bash processes braces. It is not a 1:1 implementation of how Bash
handles braces, but generally, it follows very closely. Almost all of the test cases are run through Bash first,
then our implementation is compared against the results Bash gives. There are a few cases where we have purposely
deviated. For instance, we are not handling Bash's command line inputs, so we are not giving special meaning to back
ticks and quotes at this time.
On the command line Bracex can handle more expansions than Bash itself.
## Install
```console
$ pip install bracex
```
## Documentation
Documentation is found here: https://facelessuser.github.io/bracex/.
## License
MIT License
[github-ci-image]: https://github.com/facelessuser/bracex/actions/workflows/build.yml/badge.svg?branch=master&event=push
[github-ci-link]: https://github.com/facelessuser/bracex/actions?query=workflow%3Abuild+branch%3Amaster
[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/bracex/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333
[codecov-link]: https://codecov.io/github/facelessuser/bracex
[pypi-image]: https://img.shields.io/pypi/v/bracex.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333
[pypi-link]: https://pypi.python.org/pypi/bracex
[python-image]: https://img.shields.io/pypi/pyversions/bracex?logo=python&logoColor=aaaaaa&labelColor=333333
[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333
[donate-image]: https://img.shields.io/badge/Donate-PayPal-3fabd1?logo=paypal
[donate-link]: https://www.paypal.me/facelessuser