=====================
Python Prompt Package
=====================
|PyPI Version| |Travis| |Coverage Status| |Documentation Status|
| Prompt and verify user input on the command line.
| Python 3.3+ and Wheels are supported.
The project was initiated by Stefan Fischer.
- `Documentation <https://readthedocs.org/projects/prompt>`__ is
available on PythonHosted.
- `Questions <mailto:sfischer13@ymail.com>`__ can be asked via e-mail.
- `Changes <https://github.com/sfischer13/python-prompt/blob/master/CHANGELOG.rst>`__
between releases are documented.
- `Source code <https://github.com/sfischer13/python-prompt>`__ is
tracked on GitHub.
- `Bugs <https://github.com/sfischer13/python-prompt/issues>`__ can be
reported on the issue tracker.
Install
-------
|PyPI Python Versions| |PyPI Wheel|
The package is available on
`PyPI <https://pypi.python.org/pypi/prompt>`__:
::
$ pip install prompt
Use
---
An extensive `documentation <https://readthedocs.org/projects/prompt>`__
is available.
Some simple use cases:
::
import prompt
email = prompt.email()
# modify default prompt
integer = prompt.integer(prompt="Please enter a number: ")
# allow empty response
real = prompt.real(empty=True)
# require a two digit number using a regular expression
regex = prompt.regex("^\d\d$")
Contribute
----------
| Write a bug report or send a pull request.
| Other
`contributors <https://github.com/sfischer13/python-prompt/graphs/contributors>`__
have done so before.
- `Roadmap <https://github.com/sfischer13/python-prompt/blob/master/TODO.rst>`__
of planned improvements
- `Issues <https://github.com/sfischer13/python-prompt/issues>`__ that
have been reported
License
-------
| Copyright (c) 2015-2017 Stefan Fischer
| The source code is available under the **MIT License**.
| See
`LICENSE <https://github.com/sfischer13/python-prompt/blob/master/LICENSE>`__
for further details.
.. |PyPI Version| image:: https://img.shields.io/pypi/v/prompt.svg
:target: https://pypi.python.org/pypi/prompt
.. |Travis| image:: https://img.shields.io/travis/sfischer13/python-prompt.svg
:target: https://travis-ci.org/sfischer13/python-prompt
.. |Coverage Status| image:: https://coveralls.io/repos/sfischer13/python-prompt/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/sfischer13/python-prompt?branch=master
.. |Documentation Status| image:: https://readthedocs.org/projects/prompt/badge/?version=latest
:target: http://prompt.readthedocs.org/en/latest/?badge=latest
.. |PyPI Python Versions| image:: https://img.shields.io/pypi/pyversions/prompt.svg
:target: https://pypi.python.org/pypi/prompt
.. |PyPI Wheel| image:: https://img.shields.io/pypi/wheel/prompt.svg
:target: https://pypi.python.org/pypi/prompt
=======
History
=======
| All notable changes to this project will be documented in this file.
| This project adheres to `Semantic Versioning <http://semver.org/>`__.
| You should `Keep a CHANGELOG <http://keepachangelog.com/>`__, too!
`Next Release <https://github.com/sfischer13/python-prompt/compare/v0.4.1...HEAD>`__
------------------------------------------------------------------------------------
Added
~~~~~
Changed
~~~~~~~
Deprecated
~~~~~~~~~~
Fixed
~~~~~
Removed
~~~~~~~
Security
~~~~~~~~
`0.4.1 <https://github.com/sfischer13/python-prompt/compare/v0.4.0...v0.4.1>`__ - 2017-06-05
--------------------------------------------------------------------------------------------
Changed
~~~~~~~
- improved infrastructure
`0.4.0 <https://github.com/sfischer13/python-prompt/compare/v0.3.2...v0.4.0>`__ - 2016-03-22
--------------------------------------------------------------------------------------------
Removed
~~~~~~~
- support for Python 3.2
`0.3.2 <https://github.com/sfischer13/python-prompt/compare/v0.3.1...v0.3.2>`__ - 2016-03-22
--------------------------------------------------------------------------------------------
Added
~~~~~
- unit tests
- coverage testing
`0.3.1 <https://github.com/sfischer13/python-prompt/compare/v0.3.0...v0.3.1>`__ - 2015-10-10
--------------------------------------------------------------------------------------------
Fixed
~~~~~
- display of README on PyPI
`0.3.0 <https://github.com/sfischer13/python-prompt/compare/v0.2.0...v0.3.0>`__ - 2015-10-10
--------------------------------------------------------------------------------------------
Added
~~~~~
- module documentation
- documentation on PythonHosted
`0.2.0 <https://github.com/sfischer13/python-prompt/compare/v0.1.0...v0.2.0>`__ - 2015-09-27
--------------------------------------------------------------------------------------------
Added
~~~~~
- prompt.email()
- prompt.secret()
0.1.0 - 2015-09-16
------------------
Added
~~~~~
- minimum viable product
Raw data
{
"_id": null,
"home_page": "https://github.com/sfischer13/python-prompt",
"name": "prompt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.3",
"maintainer_email": "",
"keywords": "prompt input console terminal tty",
"author": "Stefan Fischer",
"author_email": "sfischer13@ymail.com",
"download_url": "https://files.pythonhosted.org/packages/a6/f1/f550fffbdbe3ca55591d2c34f7d561ee8126a2e4f0b402a84860a31a5f68/prompt-0.4.1.tar.gz",
"platform": "",
"description": "=====================\nPython Prompt Package\n=====================\n\n|PyPI Version| |Travis| |Coverage Status| |Documentation Status|\n\n| Prompt and verify user input on the command line.\n| Python 3.3+ and Wheels are supported.\n\nThe project was initiated by Stefan Fischer.\n\n- `Documentation <https://readthedocs.org/projects/prompt>`__ is\n available on PythonHosted.\n- `Questions <mailto:sfischer13@ymail.com>`__ can be asked via e-mail.\n- `Changes <https://github.com/sfischer13/python-prompt/blob/master/CHANGELOG.rst>`__\n between releases are documented.\n- `Source code <https://github.com/sfischer13/python-prompt>`__ is\n tracked on GitHub.\n- `Bugs <https://github.com/sfischer13/python-prompt/issues>`__ can be\n reported on the issue tracker.\n\nInstall\n-------\n\n|PyPI Python Versions| |PyPI Wheel|\n\nThe package is available on\n`PyPI <https://pypi.python.org/pypi/prompt>`__:\n\n::\n\n $ pip install prompt\n\nUse\n---\n\nAn extensive `documentation <https://readthedocs.org/projects/prompt>`__\nis available.\n\nSome simple use cases:\n\n::\n\n import prompt\n\n email = prompt.email()\n\n # modify default prompt\n integer = prompt.integer(prompt=\"Please enter a number: \")\n\n # allow empty response\n real = prompt.real(empty=True)\n\n # require a two digit number using a regular expression\n regex = prompt.regex(\"^\\d\\d$\")\n\nContribute\n----------\n\n| Write a bug report or send a pull request.\n| Other\n `contributors <https://github.com/sfischer13/python-prompt/graphs/contributors>`__\n have done so before.\n\n- `Roadmap <https://github.com/sfischer13/python-prompt/blob/master/TODO.rst>`__\n of planned improvements\n- `Issues <https://github.com/sfischer13/python-prompt/issues>`__ that\n have been reported\n\nLicense\n-------\n\n| Copyright (c) 2015-2017 Stefan Fischer\n| The source code is available under the **MIT License**.\n| See\n `LICENSE <https://github.com/sfischer13/python-prompt/blob/master/LICENSE>`__\n for further details.\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/prompt.svg\n :target: https://pypi.python.org/pypi/prompt\n.. |Travis| image:: https://img.shields.io/travis/sfischer13/python-prompt.svg\n :target: https://travis-ci.org/sfischer13/python-prompt\n.. |Coverage Status| image:: https://coveralls.io/repos/sfischer13/python-prompt/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/sfischer13/python-prompt?branch=master\n.. |Documentation Status| image:: https://readthedocs.org/projects/prompt/badge/?version=latest\n :target: http://prompt.readthedocs.org/en/latest/?badge=latest\n.. |PyPI Python Versions| image:: https://img.shields.io/pypi/pyversions/prompt.svg\n :target: https://pypi.python.org/pypi/prompt\n.. |PyPI Wheel| image:: https://img.shields.io/pypi/wheel/prompt.svg\n :target: https://pypi.python.org/pypi/prompt\n\n\n=======\nHistory\n=======\n\n| All notable changes to this project will be documented in this file.\n| This project adheres to `Semantic Versioning <http://semver.org/>`__.\n| You should `Keep a CHANGELOG <http://keepachangelog.com/>`__, too!\n\n`Next Release <https://github.com/sfischer13/python-prompt/compare/v0.4.1...HEAD>`__\n------------------------------------------------------------------------------------\n\nAdded\n~~~~~\n\nChanged\n~~~~~~~\n\nDeprecated\n~~~~~~~~~~\n\nFixed\n~~~~~\n\nRemoved\n~~~~~~~\n\nSecurity\n~~~~~~~~\n\n`0.4.1 <https://github.com/sfischer13/python-prompt/compare/v0.4.0...v0.4.1>`__ - 2017-06-05\n--------------------------------------------------------------------------------------------\n\nChanged\n~~~~~~~\n\n- improved infrastructure\n\n\n`0.4.0 <https://github.com/sfischer13/python-prompt/compare/v0.3.2...v0.4.0>`__ - 2016-03-22\n--------------------------------------------------------------------------------------------\n\nRemoved\n~~~~~~~\n\n- support for Python 3.2\n\n`0.3.2 <https://github.com/sfischer13/python-prompt/compare/v0.3.1...v0.3.2>`__ - 2016-03-22\n--------------------------------------------------------------------------------------------\n\nAdded\n~~~~~\n\n- unit tests\n- coverage testing\n\n`0.3.1 <https://github.com/sfischer13/python-prompt/compare/v0.3.0...v0.3.1>`__ - 2015-10-10\n--------------------------------------------------------------------------------------------\n\nFixed\n~~~~~\n\n- display of README on PyPI\n\n`0.3.0 <https://github.com/sfischer13/python-prompt/compare/v0.2.0...v0.3.0>`__ - 2015-10-10\n--------------------------------------------------------------------------------------------\n\nAdded\n~~~~~\n\n- module documentation\n- documentation on PythonHosted\n\n`0.2.0 <https://github.com/sfischer13/python-prompt/compare/v0.1.0...v0.2.0>`__ - 2015-09-27\n--------------------------------------------------------------------------------------------\n\nAdded\n~~~~~\n\n- prompt.email()\n- prompt.secret()\n\n0.1.0 - 2015-09-16\n------------------\n\nAdded\n~~~~~\n\n- minimum viable product\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for prompting input on the command line.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/sfischer13/python-prompt"
},
"split_keywords": [
"prompt",
"input",
"console",
"terminal",
"tty"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de2abaf04fe6bef0b73666fd891db1c395813ee9691f949ae4b42500dc440adb",
"md5": "ac1363a8948a910098defec93f29dc4a",
"sha256": "98527de8dc3f0aa29669a39fbffeaf578ba6654dc836f737b6a5c6f9279002b7"
},
"downloads": -1,
"filename": "prompt-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac1363a8948a910098defec93f29dc4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.3",
"size": 7149,
"upload_time": "2017-06-05T17:01:11",
"upload_time_iso_8601": "2017-06-05T17:01:11.702112Z",
"url": "https://files.pythonhosted.org/packages/de/2a/baf04fe6bef0b73666fd891db1c395813ee9691f949ae4b42500dc440adb/prompt-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a6f1f550fffbdbe3ca55591d2c34f7d561ee8126a2e4f0b402a84860a31a5f68",
"md5": "081725bc760c08cb19af53b9a963cb3d",
"sha256": "8a7694b88f8c65188a983315e72582bf42fcc251b97042be1d2a2ad1aa0ebe0e"
},
"downloads": -1,
"filename": "prompt-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "081725bc760c08cb19af53b9a963cb3d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.3",
"size": 6500,
"upload_time": "2017-06-05T17:01:13",
"upload_time_iso_8601": "2017-06-05T17:01:13.381869Z",
"url": "https://files.pythonhosted.org/packages/a6/f1/f550fffbdbe3ca55591d2c34f7d561ee8126a2e4f0b402a84860a31a5f68/prompt-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2017-06-05 17:01:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sfischer13",
"github_project": "python-prompt",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "prompt"
}