Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magmax/python-inquirer
A collection of common interactive command line user interfaces, based on Inquirer.js (https://github.com/SBoudrias/Inquirer.js/)
https://github.com/magmax/python-inquirer
Last synced: about 2 months ago
JSON representation
A collection of common interactive command line user interfaces, based on Inquirer.js (https://github.com/SBoudrias/Inquirer.js/)
- Host: GitHub
- URL: https://github.com/magmax/python-inquirer
- Owner: magmax
- License: mit
- Created: 2014-05-02T10:23:43.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T06:42:55.000Z (about 2 months ago)
- Last Synced: 2024-07-26T07:56:41.433Z (about 2 months ago)
- Language: Python
- Size: 1.42 MB
- Stars: 985
- Watchers: 8
- Forks: 97
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- my-awesome-starred - magmax/python-inquirer - A collection of common interactive command line user interfaces, based on Inquirer.js (https://github.com/SBoudrias/Inquirer.js/) (Python)
README
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[][black]
[][read the docs]
[][tests]
[][codecov]
[][pre-commit]
[pypi status]: https://pypi.org/project/inquirer/
[read the docs]: https://python-inquirer.readthedocs.io/
[tests]: https://github.com/magmax/python-inquirer/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/magmax/python-inquirer
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
# python-inquirer
Collection of common interactive command line user interfaces, based on [Inquirer.js].
## Goal and Philosophy
Born as a [Inquirer.js] clone, it shares part of the goals and philosophy.
So, **Inquirer** should ease the process of asking end user **questions**, **parsing**, **validating** answers, managing **hierarchical prompts** and providing **error feedback**.
You can [download the python-inquirer code from GitHub] or [download the wheel from Pypi].
### Platforms support
Python-inquirer supports mainly UNIX-based platforms (eq. Mac OS, Linux, etc.). Windows has experimental support, please let us know if there are any problems!
## Installation
```sh
pip install inquirer
```
## Documentation
Documentation has been moved to [python-inquirer.readthedocs.io](https://python-inquirer.readthedocs.io/).
But here you have a couple of usage examples:
### Text
```python
import re
import inquirer
questions = [
inquirer.Text('name', message="What's your name"),
inquirer.Text('surname', message="What's your surname"),
inquirer.Text('phone', message="What's your phone number",
validate=lambda _, x: re.match('\+?\d[\d ]+\d', x),
)
]
answers = inquirer.prompt(questions)
```
### Editor
Like a Text question, but used for larger answers. It opens external text editor which is used to collect the answer.
The environment variables `$VISUAL` and `$EDITOR`, can be used to specify which editor should be used. If not present inquirer fallbacks to `vim -> emacs -> nano` in this order based on availability in the system.
External editor handling is done using great library [python-editor](https://github.com/fmoo/python-editor).
Example:
```python
import inquirer
questions = [
inquirer.Editor('long_text', message="Provide long text")
]
answers = inquirer.prompt(questions)
```
### List
Shows a list of choices, and allows the selection of one of them.
Example:
```python
import inquirer
questions = [
inquirer.List('size',
message="What size do you need?",
choices=['Jumbo', 'Large', 'Standard', 'Medium', 'Small', 'Micro'],
),
]
answers = inquirer.prompt(questions)
```
List questions can take one extra argument `carousel=False`. If set to true, the answers will rotate (back to first when pressing down on last choice, and down to last choice when pressing up on first choice)
### Checkbox
Shows a list of choices, with multiple selection.
Example:
```python
import inquirer
questions = [
inquirer.Checkbox('interests',
message="What are you interested in?",
choices=['Computers', 'Books', 'Science', 'Nature', 'Fantasy', 'History'],
),
]
answers = inquirer.prompt(questions)
```
Checkbox questions can take extra argument `carousel=False`. If set to true, the answers will rotate (back to first when pressing down on last choice, and down to last choice when pressing up on first choice)
Another argument that can be used is `locked=`. The given choices in the locked argument cannot be removed. This is useful if you want to make clear that a specific option out of the choices must be chosen.
### Path
Like Text question, but with builtin validations for working with paths.
Example:
```python
import inquirer
questions = [
inquirer.Path('log_file',
message="Where logs should be located?",
path_type=inquirer.Path.DIRECTORY,
),
]
answers = inquirer.prompt(questions)
```
## Contributing
Contributions are very welcome.
To learn more, see the [Contributor Guide].
## License
Copyright (c) 2014-2023 Miguel Ángel García ([@magmax_en]), based on [Inquirer.js], by Simon Boudrias ([@vaxilart])
Distributed under the terms of the [MIT license][license].
[license]: https://github.com/magmax/python-inquirer/blob/main/LICENSE
[@magmax_en]: https://twitter.com/magmax_en
[@vaxilart]: https://twitter.com/vaxilart
[contributor guide]: CONTRIBUTING.md
[download the python-inquirer code from github]: https://github.com/magmax/python-inquirer
[download the wheel from pypi]: https://pypi.python.org/pypi/inquirer
[examples/]: https://github.com/magmax/python-inquirer/tree/master/examples
[inquirer.js]: https://github.com/SBoudrias/Inquirer.js