Metadata-Version: 2.1
Name: fs-filepicker
Version: 0.3.7
Summary: QT Filepicker for pyfilesystem2
Home-page: https://github.com/ReimarBauer/fs_filepicker
Author: Reimar Bauer
Author-email: rb.proj@gmail.com
Maintainer: Reimar Bauer
Maintainer-email: rb.proj@gmail.com
License: Apache 2.0
Keywords: fs
Platform: any
Classifier: D
Classifier: e
Classifier: v
Classifier: e
Classifier: l
Classifier: o
Classifier: p
Classifier: m
Classifier: e
Classifier: n
Classifier: t
Classifier: 
Classifier: S
Classifier: t
Classifier: a
Classifier: t
Classifier: u
Classifier: s
Classifier: 
Classifier: :
Classifier: :
Classifier: 
Classifier: 5
Classifier: 
Classifier: -
Classifier: 
Classifier: P
Classifier: r
Classifier: o
Classifier: d
Classifier: u
Classifier: c
Classifier: t
Classifier: i
Classifier: o
Classifier: n
Classifier: /
Classifier: S
Classifier: t
Classifier: a
Classifier: b
Classifier: l
Classifier: e
Requires-Dist: fs
Requires-Dist: future

fs_filepicker
~~~~~~~~~~~~~

|Source| |Conda| |Codecov| |Codacy| |License|

.. |Source| image:: https://img.shields.io/badge/source-GitHub-303030.svg?maxAge=300&style=flat-square
   :target: https://github.com/ReimarBauer/fs_filepicker

.. |Conda| image:: https://anaconda.org/conda-forge/fs_filepicker/badges/installer/conda.svg
   :target: https://anaconda.org/conda-forge/fs_filepicker

.. |License| image:: https://anaconda.org/conda-forge/fs_filepicker/badges/license.svg
   :target: https://choosealicense.com/licenses/apache-2.0/

.. |Codecov| image:: https://codecov.io/gh/ReimarBauer/fs_filepicker/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/ReimarBauer/fs_filepicker

.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/665867585be14a4c971f2baa463312ad
   :target: https://www.codacy.com/app/ReimarBauer/fs_filepicker?utm_source=github.com&utm_medium=referral&utm_content=ReimarBauer/fs_filepicker&utm_campaign=badger


This project is based on `PyFilesystem2 <http://pyfilesystem2.readthedocs.io/>`_
As fs_url you can enter any valid url which the fs.open_fs accepts.

.. image:: docs/ui.png

Example for commandline::

   ~$: fs_filepicker -h
   usage: fs_filepicker [-h] [-v] [-s] [-d DEFAULT_NAME] [-u FS_URL]
                        [-f FILE_PATTERN] [-t TITLE]
   optional arguments:
     -h, --help            show this help message and exit
     -v, --version         show version
     -s, --save            show save button
     -d DEFAULT_NAME, --default_name DEFAULT_NAME
                           default name for saving
     -u FS_URL, --fs_url FS_URL
                           fs url to filesystem
     -f FILE_PATTERN, --file_pattern FILE_PATTERN
                           file pattern
     -t TITLE, --title TITLE
                           title of window


   ~$: fs_filepicker -u ftp://ftp.de.debian.org/debian


Examples for PyQt5::

  from PyQt5 import QtWidgets
  app = QtWidgets.QApplication([])
  from fslib.fs_filepicker import getOpenFileName, getSaveFileName, getExistingDirectory, getOpenFileNameAndFilter, \
                                  getSaveFileNameAndFilter
  filename = getOpenFileName(parent=None, fs_url=u'~/', file_pattern=u'All Files (*)',
                           title=u'Open Config File')
  print(filename)

  patterns = [u'All Files (*)', u'Config Files (*.json)']
  filename = getSaveFileName(parent=None, fs_url=u'~/', file_pattern=patterns,
                             default_filename=u'config.json',
                             title=u'Save Config File')
  print(filename)

  dirname = getExistingDirectory(parent=None, fs_url=u'~/')
  print(dirname)

  patterns = [u'Data Files (*.xml)', u'Config Files (*.json)']
  filename, pattern = getOpenFileNameAndFilter(parent=None, fs_url=u'~/', file_pattern=patterns)
  print(filename, pattern)

  patterns = [u'Data Files (*.xml)', u'Config Files (*.json)']
  filename, pattern = getSaveFileNameAndFilter(parent=None, fs_url=u'~/', file_pattern=patterns)
  print(filename, pattern)

  def load_file(self):
      from fslib.fs_filepicker import getOpenFileName
      filename = getOpenFileName(self, fs_url=u'ftp://ftp.de.debian.org/debian', file_pattern=u'All Files (*)',
                                 title=u"Debian files")





