# File dialogs for Windows
[![Coverage Status][coverage-badge]][coverage]
[![GitHub Workflow Status][status-badge]][status]
[![PyPI][pypi-badge]][pypi]
[![GitHub][licence-badge]][licence]
[![GitHub Last Commit][repo-badge]][repo]
[![GitHub Issues][issues-badge]][issues]
[![Downloads][downloads-badge]][pypi]
[![Python Version][version-badge]][pypi]
```shell
pip install windows-filedialogs
```
---
**Documentation**: [https://mrthearman.github.io/filedialogs/](https://mrthearman.github.io/filedialogs/)
**Source Code**: [https://github.com/MrThearMan/filedialogs/](https://github.com/MrThearMan/filedialogs/)
**Contributing**: [https://github.com/MrThearMan/filedialogs/blob/main/CONTRIBUTING.md](https://github.com/MrThearMan/filedialogs/blob/main/CONTRIBUTING.md)
---
Implements easy Windows file dialog functions. Requires the [pywin32](https://pypi.org/project/pywin32/) module.
### Basic use:
```python
from filedialogs import save_file_dialog, open_file_dialog, open_folder_dialog
open_path = open_file_dialog()
if open_path:
with open(open_path, "r") as f:
...
save_path = save_file_dialog()
if save_path:
with open(save_path, "w") as f:
...
open_folder = open_folder_dialog()
if open_folder:
with open(os.path.join(open_folder, ...), "w") as f:
...
```
## Documentation:
#### *open_file_dialog*
* title: str - Dialog title. Default is no title.
* directory: str - Directory to open file dialog in. Default is the current working directory.
* default_name: str - Default file name on dialog open. Default is empty.
* default_ext: str - Default file extension on dialog open. Default is no extension.
* ext: list[tuple[str, str | tuple[str, ...]]] - List of available extensions as (description, extension) tuples. Default is ("All files", "*").
* multiselect: bool - Allow multiple files to be selected. Default is False.
Returns: Path to a file to open if multiselect=False. List of the paths to files which should be opened if multiselect=True. None if file open dialog canceled.
Raises: IOError - File open dialog failed.
---
#### *save_file_dialog*
* title: str - Dialog title. Default is no title.
* directory: str - Directory to open file dialog in. Default is the current working directory.
* default_name: str - Default file name on dialog open. Default is empty.
* default_ext: str - Default file extension on dialog open. Default is no extension.
* ext: list[tuple[str, str | tuple[str, ...]]] - List of available extensions as (description, extension) tuples. Default is ("All files", "*").
Returns: Path file should be save to. None if file save dialog canceled.
Raises: IOError - File save dialog failed.
---
#### *open_folder_dialog*
* title: str - Dialog title. Default is no title.
* encoding: str - Encoding for the folder. Default is Latin-1.
Returns: Path to folder. None if no folder selected.
---
[coverage-badge]: https://coveralls.io/repos/github/MrThearMan/filedialogs/badge.svg?branch=main
[status-badge]: https://img.shields.io/github/actions/workflow/status/MrThearMan/filedialogs/test.yml?branch=main
[pypi-badge]: https://img.shields.io/pypi/v/windows-filedialogs
[licence-badge]: https://img.shields.io/github/license/MrThearMan/filedialogs
[repo-badge]: https://img.shields.io/github/last-commit/MrThearMan/filedialogs
[issues-badge]: https://img.shields.io/github/issues-raw/MrThearMan/filedialogs
[version-badge]: https://img.shields.io/pypi/pyversions/windows-filedialogs
[downloads-badge]: https://img.shields.io/pypi/dm/windows-filedialogs
[coverage]: https://coveralls.io/github/MrThearMan/filedialogs?branch=main
[status]: https://github.com/MrThearMan/filedialogs/actions/workflows/test.yml
[pypi]: https://pypi.org/project/windows-filedialogs
[licence]: https://github.com/MrThearMan/filedialogs/blob/main/LICENSE
[repo]: https://github.com/MrThearMan/filedialogs/commits/main
[issues]: https://github.com/MrThearMan/filedialogs/issues
Raw data
{
"_id": null,
"home_page": "https://mrthearman.github.io/filedialogs",
"name": "windows_filedialogs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "file,dialogs,windows,open,save",
"author": "Matti Lamppu",
"author_email": "lamppu.matti.akseli@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/23/d6/99a755fe46cbdbcb00026e6c06140929c844e93b807298d8d076d72747eb/windows_filedialogs-0.0.7.tar.gz",
"platform": null,
"description": "# File dialogs for Windows\n\n[![Coverage Status][coverage-badge]][coverage]\n[![GitHub Workflow Status][status-badge]][status]\n[![PyPI][pypi-badge]][pypi]\n[![GitHub][licence-badge]][licence]\n[![GitHub Last Commit][repo-badge]][repo]\n[![GitHub Issues][issues-badge]][issues]\n[![Downloads][downloads-badge]][pypi]\n[![Python Version][version-badge]][pypi]\n\n```shell\npip install windows-filedialogs\n```\n\n---\n\n**Documentation**: [https://mrthearman.github.io/filedialogs/](https://mrthearman.github.io/filedialogs/)\n\n**Source Code**: [https://github.com/MrThearMan/filedialogs/](https://github.com/MrThearMan/filedialogs/)\n\n**Contributing**: [https://github.com/MrThearMan/filedialogs/blob/main/CONTRIBUTING.md](https://github.com/MrThearMan/filedialogs/blob/main/CONTRIBUTING.md)\n\n---\n\nImplements easy Windows file dialog functions. Requires the [pywin32](https://pypi.org/project/pywin32/) module.\n\n### Basic use:\n\n```python\nfrom filedialogs import save_file_dialog, open_file_dialog, open_folder_dialog\n\nopen_path = open_file_dialog()\nif open_path:\n with open(open_path, \"r\") as f:\n ...\n\nsave_path = save_file_dialog()\nif save_path:\n with open(save_path, \"w\") as f:\n ...\n\nopen_folder = open_folder_dialog()\nif open_folder:\n with open(os.path.join(open_folder, ...), \"w\") as f:\n ...\n```\n\n## Documentation:\n\n#### *open_file_dialog*\n* title: str - Dialog title. Default is no title.\n* directory: str - Directory to open file dialog in. Default is the current working directory.\n* default_name: str - Default file name on dialog open. Default is empty.\n* default_ext: str - Default file extension on dialog open. Default is no extension.\n* ext: list[tuple[str, str | tuple[str, ...]]] - List of available extensions as (description, extension) tuples. Default is (\"All files\", \"*\").\n* multiselect: bool - Allow multiple files to be selected. Default is False.\n\nReturns: Path to a file to open if multiselect=False. List of the paths to files which should be opened if multiselect=True. None if file open dialog canceled.\n\nRaises: IOError - File open dialog failed.\n\n---\n\n#### *save_file_dialog*\n* title: str - Dialog title. Default is no title.\n* directory: str - Directory to open file dialog in. Default is the current working directory.\n* default_name: str - Default file name on dialog open. Default is empty.\n* default_ext: str - Default file extension on dialog open. Default is no extension.\n* ext: list[tuple[str, str | tuple[str, ...]]] - List of available extensions as (description, extension) tuples. Default is (\"All files\", \"*\").\n\nReturns: Path file should be save to. None if file save dialog canceled.\n\nRaises: IOError - File save dialog failed.\n\n---\n\n#### *open_folder_dialog*\n* title: str - Dialog title. Default is no title.\n* encoding: str - Encoding for the folder. Default is Latin-1.\n\nReturns: Path to folder. None if no folder selected.\n\n---\n\n[coverage-badge]: https://coveralls.io/repos/github/MrThearMan/filedialogs/badge.svg?branch=main\n[status-badge]: https://img.shields.io/github/actions/workflow/status/MrThearMan/filedialogs/test.yml?branch=main\n[pypi-badge]: https://img.shields.io/pypi/v/windows-filedialogs\n[licence-badge]: https://img.shields.io/github/license/MrThearMan/filedialogs\n[repo-badge]: https://img.shields.io/github/last-commit/MrThearMan/filedialogs\n[issues-badge]: https://img.shields.io/github/issues-raw/MrThearMan/filedialogs\n[version-badge]: https://img.shields.io/pypi/pyversions/windows-filedialogs\n[downloads-badge]: https://img.shields.io/pypi/dm/windows-filedialogs\n\n[coverage]: https://coveralls.io/github/MrThearMan/filedialogs?branch=main\n[status]: https://github.com/MrThearMan/filedialogs/actions/workflows/test.yml\n[pypi]: https://pypi.org/project/windows-filedialogs\n[licence]: https://github.com/MrThearMan/filedialogs/blob/main/LICENSE\n[repo]: https://github.com/MrThearMan/filedialogs/commits/main\n[issues]: https://github.com/MrThearMan/filedialogs/issues\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple Windows file dialogs.",
"version": "0.0.7",
"project_urls": {
"Bug Tracker": "https://github.com/MrThearMan/filedialogs/issues",
"Homepage": "https://mrthearman.github.io/filedialogs",
"Repository": "https://github.com/MrThearMan/filedialogs"
},
"split_keywords": [
"file",
"dialogs",
"windows",
"open",
"save"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7ad04de02c34b8c225ace2c8d549eac24b0554713f6abe8286dba00811709fe",
"md5": "bb8e595f37c1b3fecf0796449cff3296",
"sha256": "ae90391c0158aa8c2ea408c1c3eeb25706e3f9f914a3af3613e8093d545e0e0d"
},
"downloads": -1,
"filename": "windows_filedialogs-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb8e595f37c1b3fecf0796449cff3296",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 7238,
"upload_time": "2023-12-30T11:33:53",
"upload_time_iso_8601": "2023-12-30T11:33:53.092959Z",
"url": "https://files.pythonhosted.org/packages/d7/ad/04de02c34b8c225ace2c8d549eac24b0554713f6abe8286dba00811709fe/windows_filedialogs-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23d699a755fe46cbdbcb00026e6c06140929c844e93b807298d8d076d72747eb",
"md5": "00c7b26fb731bf6af9bf6ee45e922d4d",
"sha256": "af4ebb131ac28f4dbee4d9424d31e3225ebff255d05e7a74e0f3996e5458b0c4"
},
"downloads": -1,
"filename": "windows_filedialogs-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "00c7b26fb731bf6af9bf6ee45e922d4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 5975,
"upload_time": "2023-12-30T11:33:54",
"upload_time_iso_8601": "2023-12-30T11:33:54.676975Z",
"url": "https://files.pythonhosted.org/packages/23/d6/99a755fe46cbdbcb00026e6c06140929c844e93b807298d8d076d72747eb/windows_filedialogs-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-30 11:33:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MrThearMan",
"github_project": "filedialogs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "windows_filedialogs"
}
JSON
