Metadata-Version: 2.1
Name: ipyfilechooser
Version: 0.4.2
Summary: Python file chooser widget for use in Jupyter/IPython in conjunction with ipywidgets
Home-page: https://github.com/crahan/ipyfilechooser
Author: Thomas Bouve (@crahan)
Author-email: crahan@n00.be
License: MIT
Description: # ipyfilechooser
        
        A simple Python file chooser widget for use in Jupyter/IPython in conjunction with ipywidgets. The selected path and file are available via `.selected_path` and `.selected_filename` respectvely or as a single combined filepath via `.selected`. The dialog can be reset to its default path and filename by using `.reset()`. 
        
        When a typed filename matches an existing file entry in the current folder the entry will be highlighted. If a typed filename matches a folder entry in the current view the selection button is disabled ensure the user is aware of the match. To select a folder simply leave the filename field empty.
        
        To emphasize the risk of overwriting existing files, the selected filepath is displayed in green if the file does not exist and orange if it does. 
        
        [![Downloads](https://pepy.tech/badge/ipyfilechooser)](https://pepy.tech/project/ipyfilechooser)
        
        ## Usage
        
        ```
        from ipyfilechooser import FileChooser
        
        # Create and display a FileChooser widget
        fc = FileChooser('/Users/crahan/FC demo')
        display(fc)
        
        # Print the selected path, filename, or both
        print(fc.selected_path)
        print(fc.selected_filename)
        print(fc.selected)
        
        # Change defaults and reset the dialog
        fc.default_path = '/Users/crahan/'
        fc.default_filename = 'output.txt'
        fc.reset()
        
        # Shorthand reset
        fc.reset(path='/Users/crahan/', filename='output.txt')
        
        # Change hidden files
        fc.show_hidden = True
        
        # Show or hide folder icons
        fc.use_dir_icons = True
        
        # Switch to folder-only mode
        fc.show_only_dirs = True
        
        # Set a file filter pattern (uses https://docs.python.org/3/library/fnmatch.html)
        fc.filter_pattern = '*.txt'
        
        # Set multiple file filter patterns (uses https://docs.python.org/3/library/fnmatch.html)
        fc.filter_pattern = ['*.jpg', '*.png']
        
        # Change the title (use '' to hide)
        fc.title = '<b>FileChooser title</b>'
        
        # Sample callback function
        def change_title(chooser):
            chooser.title = '<b>Callback function executed</b>'
        
        # Register callback function
        fc.register_callback(change_title)
        ```
        
        ## Functions and properties
        
        ```
        fc.reset()
        fc.refresh()
        fc.register_callback(function_name)
        fc.show_hidden
        fc.use_dir_icons
        fc.show_only_dirs
        fc.rows
        fc.title
        fc.filter_pattern
        fc.default
        fc.default_path
        fc.default_filename
        fc.selected
        fc.selected_path
        fc.selected_filename
        ```
        
        ## Screenshots
        
        ### Closed vs open dialog
        
        ![Screenshot 1](https://github.com/crahan/ipyfilechooser/raw/master/screenshots/FileChooser_screenshot_1.png)
        
        ![Screenshot 2](https://github.com/crahan/ipyfilechooser/raw/master/screenshots/FileChooser_screenshot_2.png)
        
        ### Existing vs new file selection
        
        ![Screenshot 3](https://github.com/crahan/ipyfilechooser/raw/master/screenshots/FileChooser_screenshot_3.png)
        
        ![Screenshot 4](https://github.com/crahan/ipyfilechooser/raw/master/screenshots/FileChooser_screenshot_4.png)
        
        ### Quick navigation dropdown
        
        ![Screenshot 5](https://github.com/crahan/ipyfilechooser/raw/master/screenshots/FileChooser_screenshot_5.png)
        
        ### Use folder icons
        
        ![Screenshot 6](https://github.com/crahan/ipyfilechooser/raw/master/screenshots/FileChooser_screenshot_6.png)
        
        
        ## Release notes
        
        ### 0.4.2
        
        - Added ability to specify a list of `fnmatch` pattern strings for `filter_pattern`
        
        ### 0.4.1
        
        - Fixed issue with `select_default` not being applied on `reset`
        
        ### 0.4.0
        
        - Option added to specify a file filter (@andriykorchak)
        - Add support for `ValueWidget` and `get_interact_value()`
        - Updated sample notebook with filter example
        - Updated Development Status to Production/Stable
        
        ### 0.3.5
        
        - Option added to only display folders (@andriykorchak)
        
        ### 0.3.4
        
        - Option added to display folder icons (@ptooley)
        
        ### 0.3.3
        
        - Option added to add `self` as an argument to the callback function (@ptooley)
        
        ### 0.3.2
        
        - Return `None` if file is not selected (@danjjl)
        
        ### 0.3.1
        
        - Option to register a callback function (`register_callback(function_name)`)
        
        ### 0.3.0
        
        - Ability to select a folder
        - Support for Windows drive letters
        - Option to use the defaults as the selected value
        
        ### 0.2.0
        
        - First public release
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
