Metadata-Version: 2.1
Name: faster_than_walk
Version: 0.1
Summary: Faster recursive directory walk for Python.
Home-page: https://github.com/juancarlospaco/faster-than-walk#faster-than-walk
Author: Juan Carlos
Author-email: juancarlospaco@gmail.com
Maintainer: Juan Carlos
Maintainer-email: juancarlospaco@gmail.com
License: MIT
Download-URL: https://github.com/juancarlospaco/faster-than-walk/releases
Project-URL: Docs, https://github.com/juancarlospaco/faster-than-walk#faster-than-walk
Project-URL: Bugs, https://github.com/juancarlospaco/faster-than-walk/issues
Description: <meta name='keywords' content='walk, os.walk, python, faster, speed, benchmark, rapido, velocidad, optimizacion, cython, pypy, cpython, docker, json, ndjson, rapido, veloz, performance, critical, compiled, module, modulo, loc, minimalismo, minimalism, simple, small, tiny, argentina, spanish, compare, mejora'>
        
        # Faster-than-Walk
        
        [![screenshot](https://source.unsplash.com/eH_ftJYhaTY/800x402)](https://youtu.be/QiKwnlyhKrk?t=5)
        
        | Library                       | Speed    |
        |-------------------------------|----------|
        | os.walk (std lib)             | `225.98` |
        | faster_than_walk              | `70.0`   |
        
        <details>
        
        - Benchmarks run on Docker from Dockerfile on this repo.
        - Speed is IRL time to complete 10000 full recursive directory walks to `/usr/share/`.
        - Stats as of year 2019.
        
        </details>
        
        
        # Use
        
        ```python
        import faster_than_walk as ftw
        print(ftw.walks("/path/to/some/folder"))  # See Docs for more info.
        ```
        
        - `faster_than_walk.walks(folderpath: str, extensions: list, followlinks=false, yieldfiles=true, debugs=false)` Recursive directory walk from path to list of strings.
        - `faster_than_walk.walks_glob(globpattern: str)` Recursive directory walk from standard POSIX like Glob Pattern string to list of strings, allows Recursive and Non-Recursive Globs.
        - `faster_than_walk.walks_simple(folderpath: str)` Recursive directory walk from path to list of strings.
        
        
        # Docker
        
        - Make a quick test drive on Docker!.
        
        ```bash
        $ ./build-docker.sh
        $ ./run-docker.sh
        $ ./run-benchmark.sh  # Inside Docker.
        ```
        
        
        # Platforms
        
        - ✅ Linux
        - ✅ Windows
        - ✅ Mac
        - ✅ Android
        - ✅ Raspberry Pi
        - ✅ BSD
        
        
        # FAQ
        
        - Whats the idea, inspiration, reason, etc ?.
        
        [Feel free to Fork, Clone, Download, Improve, Reimplement, Play with this Open Source. Make it 10 times faster, 10 times smaller.](http://tonsky.me/blog/disenchantment)
        
        - This requires Cython ?.
        
        No.
        
        - This runs on PyPy ?.
        
        No.
        
        - This runs on Python2 ?.
        
        I dunno. (Not supported)
        
        - How can I Install it ?.
        
        `pip install faster_than_walk`
        
        - How can be faster than `os.walk` ?.
        
        I dunno.
        
        - How to Filter by File Extensions ?.
        
        `extensions = [".py", ".txt", ".tar.gz"]`
        
        (Glob Pattern may be faster for several file extensions than the extensions argument)
        
        - How to force Follow SymLinks ?.
        
        `followlinks = True`
        
        - How to force return Folders only and Not Files ?.
        
        `yieldfiles = False`
        
        - How to enable Debug ?.
        
        `debugs = True`
        
        - How to use a Glob Pattern ?.
        
        `globpattern = "*.txt"`
        
        - How to use a Recursive Glob Pattern ?.
        
        `globpattern = "**/*.txt"`
        
        - I need to `import glob` on my code to use a Glob Pattern ?.
        
        No.
        
        - Whats a Glob Pattern ?.
        
        https://en.wikipedia.org/wiki/Glob_%28programming%29
        
Keywords: python3,cpython,speed,walk
Platform: Linux
Platform: Darwin
Platform: Windows
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Provides: faster_than_walk
Requires-Python: >3.0
Description-Content-Type: text/markdown
