filelisting 1.2.2__tar.gz → 1.2.4__tar.gz

{filelisting-1.2.2/src/filelisting.egg-info → filelisting-1.2.4}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: filelisting
-Version: 1.2.2
-Summary: List files under given paths.
+Version: 1.2.4
+Summary: This project lists files under given paths.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
         
@@ -24,9 +24,12 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-Project-URL: Documentation, https://pypi.org/project/filelisting
+Project-URL: Documentation, https://filelisting.johannes-programming.online/
 Project-URL: Download, https://pypi.org/project/filelisting/#files
-Project-URL: Source, https://github.com/johannes-programming/filelisting
+Project-URL: Index, https://pypi.org/project/filelisting/
+Project-URL: Source, https://github.com/johannes-programming/filelisting/
+Project-URL: Website, https://filelisting.johannes-programming.online/
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -35,54 +38,10 @@ Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: click>=8.1.7
-Requires-Dist: getoptify>=1.0.1
+Requires-Dist: preparse>=0.0.11
 
 ===========
 filelisting
 ===========
 
-Overview
---------
-
-List files under given paths.
-
-Installation
-------------
-
-To install ``filelisting``, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install filelisting
-
-CLI
----
-
-The project provides a CLI. For more information apply the ``--help`` flag.
-
-Features
---------
-
-* ``main`` constitutes the CLI
-* ``file_generator`` takes an arbitrary number of paths and iterates over the references files
-* ``file_list`` returns a list version of ``file_generator``
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/filelisting>`_
-* `Download <https://pypi.org/project/filelisting/#files>`_
-* `Source <https://github.com/johannes-programming/filelisting>`_
-
-Credits
--------
-
-* Author: Johannes
-* Email: johannes-programming@mailfence.com
-
-Thank you for using ``filelisting``!
+Visit the website `https://filelisting.johannes-programming.online/ <https://filelisting.johannes-programming.online/>`_ for more information.

filelisting-1.2.4/README.rst

@@ -0,0 +1,5 @@
+===========
+filelisting
+===========
+
+Visit the website `https://filelisting.johannes-programming.online/ <https://filelisting.johannes-programming.online/>`_ for more information.

{filelisting-1.2.2 → filelisting-1.2.4}/pyproject.toml

@@ -9,6 +9,7 @@ authors = [
     { email = "johannes-programming@mailfence.com", name = "Johannes" },
 ]
 classifiers = [
+    "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
@@ -16,19 +17,21 @@ classifiers = [
 ]
 dependencies = [
     "click>=8.1.7",
-    "getoptify>=1.0.1",
+    "preparse>=0.0.11",
 ]
-description = "List files under given paths."
+description = "This project lists files under given paths."
 keywords = []
 name = "filelisting"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.2.2"
+version = "1.2.4"
 
 [project.license]
 file = "LICENSE.txt"
 
 [project.urls]
-Documentation = "https://pypi.org/project/filelisting"
+Documentation = "https://filelisting.johannes-programming.online/"
 Download = "https://pypi.org/project/filelisting/#files"
-Source = "https://github.com/johannes-programming/filelisting"
+Index = "https://pypi.org/project/filelisting/"
+Source = "https://github.com/johannes-programming/filelisting/"
+Website = "https://filelisting.johannes-programming.online/"

filelisting-1.2.4/src/filelisting/__init__.py

@@ -0,0 +1,2 @@
+from filelisting.core import *
+from filelisting.tests import *

filelisting-1.2.4/src/filelisting/core/__init__.py

@@ -0,0 +1,42 @@
+import os
+from typing import *
+
+import click
+import preparse
+
+__all__ = ["file_generator", "file_list", "main"]
+
+
+def file_generator(*paths: Any) -> Generator[str, None, None]:
+    "This generator yields the files under the given path."
+    for raw_path in paths:
+        path = str(raw_path)
+        path = os.path.expanduser(path)
+        path = os.path.expandvars(path)
+        if os.path.isfile(path):
+            yield path
+            continue
+        for root, dnames, fnames in os.walk(path):
+            for fname in fnames:
+                file = os.path.join(root, fname)
+                yield file
+
+
+def file_list(*paths: Any) -> List[str]:
+    "This function returns a list of the files under the given path."
+    return list(file_generator(*paths))
+
+
+@preparse.PreParser(posix=False).click()
+@click.command(add_help_option=False)
+@click.help_option("-h", "--help")
+@click.version_option(None, "-V", "--version")
+@click.argument("path", nargs=-1)
+def main(path):
+    "List files under given paths."
+    for f in file_list(*path):
+        click.echo(f)
+
+
+if __name__ == "__main__":
+    main()

filelisting-1.2.4/src/filelisting/tests/__init__.py

@@ -0,0 +1,11 @@
+import unittest
+
+__all__ = ["test"]
+
+
+def test() -> unittest.TextTestResult:
+    loader = unittest.TestLoader()
+    tests = loader.discover(start_dir="filelisting.tests")
+    runner = unittest.TextTestRunner()
+    result = runner.run(tests)
+    return result

filelisting-1.2.4/src/filelisting/tests/test_1984.py

@@ -0,0 +1,10 @@
+import unittest
+
+
+class Test1984(unittest.TestCase):
+    def test_1984(self):
+        self.assertEqual(2 + 2, 4, "Ignorance is Strength")
+
+
+if __name__ == "__main__":
+    unittest.main()

{filelisting-1.2.2 → filelisting-1.2.4/src/filelisting.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: filelisting
-Version: 1.2.2
-Summary: List files under given paths.
+Version: 1.2.4
+Summary: This project lists files under given paths.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
         
@@ -24,9 +24,12 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-Project-URL: Documentation, https://pypi.org/project/filelisting
+Project-URL: Documentation, https://filelisting.johannes-programming.online/
 Project-URL: Download, https://pypi.org/project/filelisting/#files
-Project-URL: Source, https://github.com/johannes-programming/filelisting
+Project-URL: Index, https://pypi.org/project/filelisting/
+Project-URL: Source, https://github.com/johannes-programming/filelisting/
+Project-URL: Website, https://filelisting.johannes-programming.online/
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -35,54 +38,10 @@ Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: click>=8.1.7
-Requires-Dist: getoptify>=1.0.1
+Requires-Dist: preparse>=0.0.11
 
 ===========
 filelisting
 ===========
 
-Overview
---------
-
-List files under given paths.
-
-Installation
-------------
-
-To install ``filelisting``, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install filelisting
-
-CLI
----
-
-The project provides a CLI. For more information apply the ``--help`` flag.
-
-Features
---------
-
-* ``main`` constitutes the CLI
-* ``file_generator`` takes an arbitrary number of paths and iterates over the references files
-* ``file_list`` returns a list version of ``file_generator``
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/filelisting>`_
-* `Download <https://pypi.org/project/filelisting/#files>`_
-* `Source <https://github.com/johannes-programming/filelisting>`_
-
-Credits
--------
-
-* Author: Johannes
-* Email: johannes-programming@mailfence.com
-
-Thank you for using ``filelisting``!
+Visit the website `https://filelisting.johannes-programming.online/ <https://filelisting.johannes-programming.online/>`_ for more information.

{filelisting-1.2.2 → filelisting-1.2.4}/src/filelisting.egg-info/SOURCES.txt

@@ -9,4 +9,7 @@ src/filelisting.egg-info/PKG-INFO
 src/filelisting.egg-info/SOURCES.txt
 src/filelisting.egg-info/dependency_links.txt
 src/filelisting.egg-info/requires.txt
-src/filelisting.egg-info/top_level.txt
+src/filelisting.egg-info/top_level.txt
+src/filelisting/core/__init__.py
+src/filelisting/tests/__init__.py
+src/filelisting/tests/test_1984.py

filelisting-1.2.4/src/filelisting.egg-info/requires.txt

@@ -0,0 +1,2 @@
+click>=8.1.7
+preparse>=0.0.11

filelisting-1.2.2/README.rst

@@ -1,49 +0,0 @@
-===========
-filelisting
-===========
-
-Overview
---------
-
-List files under given paths.
-
-Installation
-------------
-
-To install ``filelisting``, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install filelisting
-
-CLI
----
-
-The project provides a CLI. For more information apply the ``--help`` flag.
-
-Features
---------
-
-* ``main`` constitutes the CLI
-* ``file_generator`` takes an arbitrary number of paths and iterates over the references files
-* ``file_list`` returns a list version of ``file_generator``
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/filelisting>`_
-* `Download <https://pypi.org/project/filelisting/#files>`_
-* `Source <https://github.com/johannes-programming/filelisting>`_
-
-Credits
--------
-
-* Author: Johannes
-* Email: johannes-programming@mailfence.com
-
-Thank you for using ``filelisting``!

filelisting-1.2.2/src/filelisting/__init__.py

@@ -1,38 +0,0 @@
-import os as _os
-
-import click as _click
-import getoptify as _getoptify
-
-_CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
-
-
-def file_generator(*paths):
-    for raw_path in paths:
-        path = raw_path
-        path = _os.path.expanduser(path)
-        path = _os.path.expandvars(path)
-        if _os.path.isfile(path):
-            yield path
-            continue
-        for root, dnames, fnames in _os.walk(path):
-            for fname in fnames:
-                file = _os.path.join(root, fname)
-                yield file
-
-
-def file_list(*paths):
-    return list(file_generator(*paths))
-
-
-@_getoptify.command(shortopts="hV")
-@_click.command(context_settings=_CONTEXT_SETTINGS)
-@_click.version_option(None, "-V", "--version")
-@_click.argument("path", nargs=-1)
-def main(path):
-    """List files under given paths."""
-    for f in file_list(*path):
-        _click.echo(f)
-
-
-if __name__ == "__main__":
-    main()

filelisting-1.2.2/src/filelisting.egg-info/requires.txt

@@ -1,2 +0,0 @@
-click>=8.1.7
-getoptify>=1.0.1