Metadata-Version: 2.1
Name: kivymd-extensions.filemanager
Version: 0.1.3
Summary: File manager for desktop
Home-page: https://github.com/kivymd-extensions/filemanager
Author: KivyMD Team and other contributors
Author-email: kivydevelopment@gmail.com
License: MIT
Project-URL: Tracker, https://github.com/kivymd-extensions/filemanager/issues
Keywords: kivymd_extensions,kivymd,kivy,material,ui
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Android
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: iOS
Classifier: Operating System :: MacOS
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.6
Description-Content-Type: text/markdown; charset=UTF-8
Requires-Dist: kivymd (>=0.104.1)
Requires-Dist: kivy (>=1.11.1)
Provides-Extra: dev
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort[pyproject] ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-asyncio ; extra == 'dev'
Requires-Dist: pytest-timeout ; extra == 'dev'
Requires-Dist: coveralls ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-autoapi (==1.4.0) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'

# File Manager

<img align="left" width="128" src="https://github.com/kivymd-extensions/filemanager/raw/main/docs/sources/_static/logo-kivymd.png"/>

Desktop file manager developed on the Kivy platform using the KivyMD library.
Perhaps the file manager will work on mobile devices, but we are not even trying to check if this is the case.
We are not testing this library on mobile devices or adapting it for mobile devices.
Because, as the name suggests, we are developing this module for desktop use.

[![Documentation Status](https://readthedocs.org/projects/file-manager/badge/?version=latest)](https://file-manager.readthedocs.io/en/latest/?badge=latest)

## Installation

```bash
pip install kivymd_extensions.filemanager
```

### Dependencies:

- [KivyMD](https://github.com/kivymd/KivyMD) >= 0.104.1
- [Kivy](https://github.com/kivy/kivy) >= 1.10.1 ([Installation](https://kivy.org/doc/stable/gettingstarted/installation.html))
- [Python 3.6+](https://www.python.org/)

## Documentation

### Usage

```python
from kivymd.app import MDApp

from kivymd_extensions.filemanager import FileManager


class MainApp(MDApp):
    def on_start(self):
        FileManager().open()


if __name__ == "__main__":
    MainApp().run()
```

<p align="center">
  <a href="https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/filemanager/filemanager-preview.png">
    <img width="800" src="https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/filemanager/filemanager-preview.png" title="Preview file manager">
  </a>
</p>

### Customization

```python
FileManager(path_to_skin="/Users/macbookair/data/images").open()
```

<p align="center">
  <a href="https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/filemanager/filemanager-custom.png">
    <img width="800" src="https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/filemanager/filemanager-custom.png" title="Custom file manager">
  </a>
</p>

## Examples

```bash
git clone https://github.com/kivymd-extensions/filemanager.git
cd filemanager
cd examples/full_example
python main.py
```

### Support

If you need assistance or you have a question, you can ask for help on our mailing list:

- **Discord server:** https://discord.gg/wu3qBST
- _Email:_ kivydevelopment@gmail.com


