textual-fspicker


Nametextual-fspicker JSON
Version 0.0.9 PyPI version JSON
download
home_pagehttps://github.com/davep/textual-fspicker
SummaryA simple Textual filesystem picker dialog library.
upload_time2023-06-04 07:57:34
maintainerDave Pearson
docs_urlNone
authorDave Pearson
requires_python>=3.7
licenseLicense :: OSI Approved :: MIT License
keywords terminal library file system filesystem dialog
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # textual-fspicker

![Viewing its own directory](https://raw.githubusercontent.com/davep/textual-fspicker/main/img/textual-fspicker.png)
*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
```

## 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](https://www.textualize.io/)).

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](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.7",
    "maintainer_email": "davep@davep.org",
    "keywords": "terminal,library,file system,filesystem,dialog",
    "author": "Dave Pearson",
    "author_email": "davep@davep.org",
    "download_url": "",
    "platform": null,
    "description": "# textual-fspicker\n\n![Viewing its own directory](https://raw.githubusercontent.com/davep/textual-fspicker/main/img/textual-fspicker.png)\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## It's early days\n\nThis is a very early release of this code, it's still very much a work in\nprogress. This means things may change and break; it's also sitting atop\nTextual which is, of course, still undergoing rapid development. As much as\npossible I'll try and ensure that it's always working with the latest stable\nrelease of Textual.\n\nAlso, because it's early days... while I love the collaborative aspect of\nFOSS, I'm highly unlikely to be accepting any non-trivial PRs at the moment.\nDeveloping this is a learning exercise for me, it's a hobby project, and\nit's also something to help me further test Textual (disclaimer for those\nwho may not have gathered, I am employed by\n[Textualize](https://www.textualize.io/)).\n\nOn the other hand: I'm *very* open to feedback and suggestions so don't\nhesitate to engage with me in Discussions, or if it's a bug, in Issues. I\ncan't and won't promise that I'll take everything on board (see above about\nhobby project, etc), but helpful input should help make this as useful as\npossible in the longer term.\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.9",
    "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": "988c5d54046e790ab8f570ae843c5f73ae7169ec571fee6e0816ea3ab7a579c2",
                "md5": "f13c49c71fdbd17f42d73e20a0e9fed6",
                "sha256": "632958c80a5db0d258855af8496f8bdebe67e3d6af2a7bf485ca1258de3eca50"
            },
            "downloads": -1,
            "filename": "textual_fspicker-0.0.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f13c49c71fdbd17f42d73e20a0e9fed6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 17409,
            "upload_time": "2023-06-04T07:57:34",
            "upload_time_iso_8601": "2023-06-04T07:57:34.823821Z",
            "url": "https://files.pythonhosted.org/packages/98/8c/5d54046e790ab8f570ae843c5f73ae7169ec571fee6e0816ea3ab7a579c2/textual_fspicker-0.0.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-04 07:57:34",
    "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"
}
        
Elapsed time: 0.07703s