Skip to main content

A simple Textual filesystem picker dialog library.

Project description

textual-fspicker

Viewing its own directory 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:

$ pip install textual-fspicker

It's early days

This is a very early release of this code, it's still very much a work in progress. This means things may change and break; it's also sitting atop Textual which is, of course, still undergoing rapid development. As much as possible I'll try and ensure that it's always working with the latest stable release of Textual.

Also, because it's early days... while I love the collaborative aspect of FOSS, I'm highly unlikely to be accepting any non-trivial PRs at the moment. Developing this is a learning exercise for me, it's a hobby project, and it's also something to help me further test Textual (disclaimer for those who may not have gathered, I am employed by Textualize).

On the other hand: I'm very open to feedback and suggestions so don't hesitate to engage with me in Discussions, or if it's a bug, in Issues. I can't and won't promise that I'll take everything on board (see above about hobby project, etc), but helpful input should help make this as useful as possible in the longer term.

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.

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
  • Add a more file-save-oriented dialog
  • Add a directory picking dialog
  • Add file filtering (extensions using Select)
  • 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

textual_fspicker-0.0.10-py3-none-any.whl (17.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page