| Name | cursesplus JSON |
| Version |
3.16.5
JSON |
| download |
| home_page | None |
| Summary | An extension program to curses that offers option menus, message boxes, file dialogues and more |
| upload_time | 2024-09-01 03:27:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Curses Plus
Extension library to curses
## How To Install
Use ```pip3 install cursesplus```
on Linux or ```py -m pip install cursesplus```
on Windows
### SPECIAL INSTRUCTIONS FOR WINDOWS
For Windows you need to also install ```windows-curses``` or related program
to provide the basic curses functionality
# What's New?
## 3.16.5
- Fix critical bug in input
- Textview is now more colourful
## 3.16.4
- Add the ability to do home, end, pgup, and pgdown on textview
## NOTICE! 3.x - Breaking Changes
**The following changes likely require changes in your code**
- Move filline, showcursor, and hidecursor to a new module called utils.
- Fix spelling issue, utils.filline is now utils.fill_line
- Change displayops to optionmenu. Please refactor all calls from displayops() to optionmenu(): No other changes are required
- Remove legacy function `showerror`. Use messagebox.showerror as a replacement
- Remove legacy function `askyesno_old`. Use messagebox.askyesno as a replacement
- Combine `displaymsg` and `displaymsgnodelay` into one function
- Existing `displaymsgnodelay` calls can be changed to `displaymsg(stdscr,[messages],False)`, so change the flag wait_for_keypress to false
- Remove redundant american function `set_color`. You can either use the (correct) spelling `set_colour` or you can not use this library.
# Documentation
## transitions.py
transitions contains many transitions to add animations to your program
### __exec(func,args)
**NOTE: THIS IS AN INTERNAL FUNCTION, IT IS NOT MEANT TO BE USED BY THE COMMON USER**
This executes `func(args)`
### horizontal_bars(stdscr,func_to_call=None,args=(),speed=1)
This is a replacement function to old's type zero. It fills the screen from the top down with horizontal white bars. It then replaces them with black bars in the same configuration.
- `stdscr` is a curses window object
- `func_to_call` is a function. If it is set to none, no function is called
- `args` is a tuple. The tuple will be passed to the function as arguments
- `speed` is an int. A higher value increases the animation speed. A lower value (0 - 1) makes it slower. If you set speed to 0, the program will crash.
### random_blocks(stdscr,func_to_call=None,args=(),speed=1)
This is a replacement for old's type one transition. It fills random characters of the screen with blocks until the whole screen is covered, then it removes it in the same fashion.
- `stdscr` is a curses window object
- `func_to_call` is a function. If it is set to none, no function is called
- `args` is a tuple. The tuple will be passed to the function as arguments
- `speed` is an int. A higher value increases the animation speed. A lower value (0 - 1) makes it slower. If you set speed to 0, the program will crash.
### vertical_bars(stdscr,func_to_call=None,args=(),speed=1)
This is an all new transition. It functions like horizontal bars except they are vertical and go left to right.
- `stdscr` is a curses window object
- `func_to_call` is a function. If it is set to none, no function is called
- `args` is a tuple. The tuple will be passed to the function as arguments
- `speed` is an int. A higher value increases the animation speed. A lower value (0 - 1) makes it slower. If you set speed to 0, the program will crash.
## utils.py
Utils.py Contain a series of non-ui utility functions. By non-ui I mean that it does not show a screen and it is non-interactive. It is meant to enhance the creation of custom menus.
### fill_line(stdscr,line,colour)
This function fills row `line` with the colour `colour`.
- `stdscr` is a curses window object
- `line` is an int. It is the row number you wish to fill in
- `colour` is a curses colour. Use `cursesplus.set_colour()` for this
### hidecursor()
This function hides the console cursor
### showcursor()
This function shows the console cursor
## constants.py
constants.py contains a series of constants such as colours and special lines.
** This documentation is not yet complete. There are many more features than this **
Raw data
{
"_id": null,
"home_page": null,
"name": "cursesplus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Enderbyte Programs <enderbyte09@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fb/82/c0058ed7195ff360109ef2b8b518e52e40c211e9c174e25480e50fbd4c7d/cursesplus-3.16.5.tar.gz",
"platform": null,
"description": "# Curses Plus\nExtension library to curses\n\n## How To Install\nUse ```pip3 install cursesplus```\non Linux or ```py -m pip install cursesplus```\non Windows\n\n### SPECIAL INSTRUCTIONS FOR WINDOWS\n\nFor Windows you need to also install ```windows-curses``` or related program\nto provide the basic curses functionality\n\n# What's New?\n\n## 3.16.5\n\n- Fix critical bug in input\n\n- Textview is now more colourful\n\n## 3.16.4\n\n- Add the ability to do home, end, pgup, and pgdown on textview\n\n## NOTICE! 3.x - Breaking Changes\n\n**The following changes likely require changes in your code**\n\n- Move filline, showcursor, and hidecursor to a new module called utils.\n\n- Fix spelling issue, utils.filline is now utils.fill_line\n\n- Change displayops to optionmenu. Please refactor all calls from displayops() to optionmenu(): No other changes are required\n\n- Remove legacy function `showerror`. Use messagebox.showerror as a replacement\n\n- Remove legacy function `askyesno_old`. Use messagebox.askyesno as a replacement\n\n- Combine `displaymsg` and `displaymsgnodelay` into one function\n\n- Existing `displaymsgnodelay` calls can be changed to `displaymsg(stdscr,[messages],False)`, so change the flag wait_for_keypress to false\n\n- Remove redundant american function `set_color`. You can either use the (correct) spelling `set_colour` or you can not use this library.\n\n\n# Documentation\n\n## transitions.py\n\ntransitions contains many transitions to add animations to your program\n\n### __exec(func,args)\n\n**NOTE: THIS IS AN INTERNAL FUNCTION, IT IS NOT MEANT TO BE USED BY THE COMMON USER**\n\nThis executes `func(args)`\n\n### horizontal_bars(stdscr,func_to_call=None,args=(),speed=1)\n\nThis is a replacement function to old's type zero. It fills the screen from the top down with horizontal white bars. It then replaces them with black bars in the same configuration.\n\n- `stdscr` is a curses window object\n\n- `func_to_call` is a function. If it is set to none, no function is called\n\n- `args` is a tuple. The tuple will be passed to the function as arguments\n\n- `speed` is an int. A higher value increases the animation speed. A lower value (0 - 1) makes it slower. If you set speed to 0, the program will crash.\n\n### random_blocks(stdscr,func_to_call=None,args=(),speed=1)\n\nThis is a replacement for old's type one transition. It fills random characters of the screen with blocks until the whole screen is covered, then it removes it in the same fashion.\n\n- `stdscr` is a curses window object\n\n- `func_to_call` is a function. If it is set to none, no function is called\n\n- `args` is a tuple. The tuple will be passed to the function as arguments\n\n- `speed` is an int. A higher value increases the animation speed. A lower value (0 - 1) makes it slower. If you set speed to 0, the program will crash.\n\n### vertical_bars(stdscr,func_to_call=None,args=(),speed=1)\n\nThis is an all new transition. It functions like horizontal bars except they are vertical and go left to right.\n\n- `stdscr` is a curses window object\n\n- `func_to_call` is a function. If it is set to none, no function is called\n\n- `args` is a tuple. The tuple will be passed to the function as arguments\n\n- `speed` is an int. A higher value increases the animation speed. A lower value (0 - 1) makes it slower. If you set speed to 0, the program will crash.\n\n## utils.py\n\nUtils.py Contain a series of non-ui utility functions. By non-ui I mean that it does not show a screen and it is non-interactive. It is meant to enhance the creation of custom menus.\n\n### fill_line(stdscr,line,colour)\n\nThis function fills row `line` with the colour `colour`.\n\n- `stdscr` is a curses window object\n\n- `line` is an int. It is the row number you wish to fill in\n\n- `colour` is a curses colour. Use `cursesplus.set_colour()` for this\n\n### hidecursor()\n\nThis function hides the console cursor\n\n### showcursor()\n\nThis function shows the console cursor\n\n## constants.py\n\nconstants.py contains a series of constants such as colours and special lines.\n\n** This documentation is not yet complete. There are many more features than this **\n",
"bugtrack_url": null,
"license": null,
"summary": "An extension program to curses that offers option menus, message boxes, file dialogues and more",
"version": "3.16.5",
"project_urls": {
"Bug Tracker": "https://github.com/Enderbyte-Programs/Curses-Plus/issues",
"Homepage": "https://github.com/Enderbyte-Programs/Curses-Plus"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db359653e5ec74ec324a9f4dccce581f6949b0130fef217c4798cd955396103f",
"md5": "a95b4448f1125accc4131bb67557b201",
"sha256": "08e359ff75582d119ce29af886fb6daad1a55bc9fb2afb6687f28198896398d3"
},
"downloads": -1,
"filename": "cursesplus-3.16.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a95b4448f1125accc4131bb67557b201",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19026,
"upload_time": "2024-09-01T03:27:50",
"upload_time_iso_8601": "2024-09-01T03:27:50.881254Z",
"url": "https://files.pythonhosted.org/packages/db/35/9653e5ec74ec324a9f4dccce581f6949b0130fef217c4798cd955396103f/cursesplus-3.16.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb82c0058ed7195ff360109ef2b8b518e52e40c211e9c174e25480e50fbd4c7d",
"md5": "60d395863aa265124402a207beeddf43",
"sha256": "8681551b551ab921634f8b777cf1a9fed9a1204b6636f69bc8fb41ffb9cb3acb"
},
"downloads": -1,
"filename": "cursesplus-3.16.5.tar.gz",
"has_sig": false,
"md5_digest": "60d395863aa265124402a207beeddf43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 19071,
"upload_time": "2024-09-01T03:27:52",
"upload_time_iso_8601": "2024-09-01T03:27:52.432945Z",
"url": "https://files.pythonhosted.org/packages/fb/82/c0058ed7195ff360109ef2b8b518e52e40c211e9c174e25480e50fbd4c7d/cursesplus-3.16.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 03:27:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Enderbyte-Programs",
"github_project": "Curses-Plus",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cursesplus"
}
