https://github.com/roo-oliv/pycollect

Utility library to collect valid Python files recursively
https://github.com/roo-oliv/pycollect

collect directory-traversal module python-files python-module python3

Last synced: 9 days ago
JSON representation

Utility library to collect valid Python files recursively

• Host: GitHub
• URL: https://github.com/roo-oliv/pycollect
• Owner: roo-oliv
• License: mit
• Created: 2019-07-27T20:01:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T18:08:14.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T17:19:53.891Z (27 days ago)
• Topics: collect, directory-traversal, module, python-files, python-module, python3
• Language: Python
• Homepage:
• Size: 386 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
.. _pycollect:

pycollect

=========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - license

      - |license|

    * - docs

      - |docs|

    * - tests

      - |build| |requires| |coveralls|

    * - package

      - |version| |wheel| |supported-versions| |supported-implementations| |platforms|

.. |docs| image:: https://img.shields.io/badge/docs-GitHub%20Pages-black

    :target: https://allrod5.github.io/pycollect/

    :alt: Documentation Status

.. |build| image:: https://github.com/allrod5/pycollect/workflows/build/badge.svg

    :alt: Build Status

    :target: https://github.com/allrod5/pycollect/actions

.. |requires| image:: https://requires.io/github/allrod5/pycollect/requirements.svg?branch=master

    :alt: Requirements Status

    :target: https://requires.io/github/allrod5/pycollect/requirements/?branch=master

.. |coveralls| image:: https://coveralls.io/repos/allrod5/pycollect/badge.svg?branch=master&service=github

    :alt: Coverage Status

    :target: https://coveralls.io/r/allrod5/pycollect

.. |version| image:: https://img.shields.io/pypi/v/pycollect.svg

    :alt: PyPI Package latest release

    :target: https://pypi.org/project/pycollect

.. |wheel| image:: https://img.shields.io/pypi/wheel/pycollect.svg

    :alt: PyPI Wheel

    :target: https://pypi.org/project/pycollect

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/pycollect.svg

    :alt: Supported versions

    :target: https://pypi.org/project/pycollect

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/pycollect.svg

    :alt: Supported implementations

    :target: https://pypi.org/project/pycollect

.. |license| image:: https://img.shields.io/github/license/allrod5/pycollect

    :alt: GitHub license

    :target: https://github.com/allrod5/pycollect/blob/master/LICENSE

.. |platforms| image:: https://img.shields.io/badge/platforms-windows%20%7C%20macos%20%7C%20linux-lightgrey

    :alt: Supported Platforms

    :target: https://github.com/allrod5/pycollect/blob/master/.github/workflows/build.yml#L11

.. end-badges

Utility library dealing with Python files.

**Features**

 * Collect Python files recursively from a given directory

 * Find the Python module name respective to a Python file

Installation

============

.. code-block:: bash

    pip install pycollect

Basic Usage

===========

Collect Python files

--------------------

.. code-block:: python

    collector = PythonFileCollector()

    python_files = collector.collect()

When no explicit directory is given the parent folder of caller's file will be used.

It is possible to define custom exclusion patterns. `See the docs for more `__.

Get the module name of a Python file

------------------------------------

.. code-block:: python

    module_name = find_module_name(filepath)

As there can be multiple valid module names for a given file, by default the outermost

module name is returned. The inverse behaviour can be enabled with the ``innermost``

parameter. `See the docs for more `__.

Documentation

=============

See the complete docs at `allrod5.github.io/pycollect `__.

`Integration tests `__

can be pretty helpful to understand pycollect usage more in-depth too.

See also

--------

* `CONTRIBUTING `__: Bug reports, feature requests, documentation & pull requests.

* `CHANGELOG `__: See what's changed in each version.

* `AUTHORS `__: Know who's behind the project.