https://github.com/lpenz/grexd
Interactive console regular expression editor using prompt-toolkit
https://github.com/lpenz/grexd
Last synced: 2 months ago
JSON representation
Interactive console regular expression editor using prompt-toolkit
- Host: GitHub
- URL: https://github.com/lpenz/grexd
- Owner: lpenz
- License: mit
- Created: 2024-03-18T20:44:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T13:52:09.000Z (about 1 year ago)
- Last Synced: 2025-02-21T17:50:51.177Z (3 months ago)
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://github.com/lpenz/grexd/actions/workflows/ci.yml)
[](https://coveralls.io/github/lpenz/grexd?branch=main)
[](https://pypi.org/project/grexd/)
[](https://github.com/lpenz/grexd/releases)
# grexd
A console regular expression editor based on python's [prompt-toolkit].
## Installation
### Releases
grexd can be installed via [pypi]:
```
pip install grexd
```
For [nix] users, it is also available as a [flake].
### Repository
We can also clone the github repository and install grexd from it with:
```
pip install .
```
We can also install it for the current user only by running instead:
```
pip install --user .
```
## Development
grexd uses the standard python3 infra. To develop and test the module:
- Clone the repository and go into the directory:
```
git clone [email protected]:lpenz/grexd.git
cd grexd
```
- Use [`venv`] to create a local virtual environment with
```
python -m venv venv
```
- Activate the environment by running the shell-specific `activate`
script in `./venv/bin/`. For [fish], for instance, run:
```
source ./venv/bin/activate.fish
```
- Install grexd in "editable mode":
```
pip install -e '.[test]'
```
- To run the tests:
```
pytest
```
Or, to run the tests with coverage:
```
pytest --cov
```
- Finally, to exit the environment and clean it up:
```
deactivate
rm -rf venv
```
[pypi]: https://pypi.org/project/grexd/
[nix]: https://nixos.org/
[flake]: https://nixos.wiki/wiki/Flakes
[`venv`]: https://docs.python.org/3/library/venv.html
[prompt-toolkit]: https://github.com/prompt-toolkit/python-prompt-toolkit