# textual-fspicker
*An example of `textual-fspicker` being used in a Textual application*
## Introduction
This library provides a simple set of filesystem navigation and picking
dialogs (actually, as of the time of writing, it only provides two, this is
a very early WiP you're seeing). The aim is to provide "ready to go" dialogs
that should also be fairly easy to tailor to your own applications.
## Installing
The package can be installed with `pip` or related tools, for example:
```sh
$ pip install textual-fspicker
```
## The library
Right at the moment there's just two dialogs available:
- `FileOpen` -- For selecting a file from the filesystem.
- `FileSave` -- For selecting a file for saving in the filesystem.
- `SelectDirectory` -- For selecting a directory from the filesysrem.
You can see them in action in the [demo/test
code](https://github.com/davep/textual-fspicker/blob/main/textual_fspicker/__main__.py).
Yes, I know that documentation is lacking right now -- I'm still fleshing
out how this will work and what it will provide -- so the best place to see
how the code can be used is in that demo/test code.
## TODO
- [ ] Flesh out what's displayed for directory entries
- [ ] Add lots of styling options for directory entries
- [ ] Settle on a final set of default styles for the dialogs
- [X] Add a more file-save-oriented dialog
- [X] Add a directory picking dialog
- [X] Add file filtering (extensions using `Select`)
- [X] Expose the hidden show/hide facility of the navigator in the dialogs
- [ ] Better documentation
- [ ] Test on Windows
- [ ] Add custom mtime formatting
- [ ] Add support for showing different times
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/textual-fspicker",
"name": "textual-fspicker",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "davep@davep.org",
"keywords": "terminal, library, file system, filesystem, dialog",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "https://files.pythonhosted.org/packages/e5/c4/e8129359ab36c7d34efab08182a43b27b43712fa1354476fa3eb3149de82/textual_fspicker-0.0.11.tar.gz",
"platform": null,
"description": "# textual-fspicker\n\n\n*An example of `textual-fspicker` being used in a Textual application*\n\n## Introduction\n\nThis library provides a simple set of filesystem navigation and picking\ndialogs (actually, as of the time of writing, it only provides two, this is\na very early WiP you're seeing). The aim is to provide \"ready to go\" dialogs\nthat should also be fairly easy to tailor to your own applications.\n\n## Installing\n\nThe package can be installed with `pip` or related tools, for example:\n\n```sh\n$ pip install textual-fspicker\n```\n\n## The library\n\nRight at the moment there's just two dialogs available:\n\n- `FileOpen` -- For selecting a file from the filesystem.\n- `FileSave` -- For selecting a file for saving in the filesystem.\n- `SelectDirectory` -- For selecting a directory from the filesysrem.\n\nYou can see them in action in the [demo/test\ncode](https://github.com/davep/textual-fspicker/blob/main/textual_fspicker/__main__.py).\n\nYes, I know that documentation is lacking right now -- I'm still fleshing\nout how this will work and what it will provide -- so the best place to see\nhow the code can be used is in that demo/test code.\n\n## TODO\n\n- [ ] Flesh out what's displayed for directory entries\n- [ ] Add lots of styling options for directory entries\n- [ ] Settle on a final set of default styles for the dialogs\n- [X] Add a more file-save-oriented dialog\n- [X] Add a directory picking dialog\n- [X] Add file filtering (extensions using `Select`)\n- [X] Expose the hidden show/hide facility of the navigator in the dialogs\n- [ ] Better documentation\n- [ ] Test on Windows\n- [ ] Add custom mtime formatting\n- [ ] Add support for showing different times\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: MIT License",
"summary": "A simple Textual filesystem picker dialog library.",
"version": "0.0.11",
"project_urls": {
"Discussions": "https://github.com/davep/textual-fspicker/discussions",
"Documentation": "https://github.com/davep/textual-fspicker/blob/main/README.md",
"Homepage": "https://github.com/davep/textual-fspicker",
"Issues": "https://github.com/davep/textual-fspicker/issues",
"Source": "https://github.com/davep/textual-fspicker"
},
"split_keywords": [
"terminal",
" library",
" file system",
" filesystem",
" dialog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d4ae15ec8ccc5af1b058c3c61e6ef69aa0751954a9671846a8081c6e30b7088",
"md5": "dcf98f0440f974e761d0e1702449a3aa",
"sha256": "8c8e2bf5ddf57874f046ea01b1cef77a2a983fbc8e1953f6e9b479751b7303b6"
},
"downloads": -1,
"filename": "textual_fspicker-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dcf98f0440f974e761d0e1702449a3aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16824,
"upload_time": "2024-04-29T14:03:14",
"upload_time_iso_8601": "2024-04-29T14:03:14.238700Z",
"url": "https://files.pythonhosted.org/packages/1d/4a/e15ec8ccc5af1b058c3c61e6ef69aa0751954a9671846a8081c6e30b7088/textual_fspicker-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c4e8129359ab36c7d34efab08182a43b27b43712fa1354476fa3eb3149de82",
"md5": "1d1f82f29cd9a9d8b53b7998a92cf755",
"sha256": "052304e94b9d4f6af75bf338a8d1a34b7a12f511d018eba2a4a3151159df4db5"
},
"downloads": -1,
"filename": "textual_fspicker-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "1d1f82f29cd9a9d8b53b7998a92cf755",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13333,
"upload_time": "2024-04-29T14:03:15",
"upload_time_iso_8601": "2024-04-29T14:03:15.418654Z",
"url": "https://files.pythonhosted.org/packages/e5/c4/e8129359ab36c7d34efab08182a43b27b43712fa1354476fa3eb3149de82/textual_fspicker-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 14:03:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "textual-fspicker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "textual-fspicker"
}
JSON
