Metadata-Version: 2.1
Name: file-clerk
Version: 1.1.2
Summary: A collection of functions for dealing with files and file content.
Home-page: https://github.com/HundredVisionsGuy/file-clerk
License: MIT
Keywords: file handling,paths,clerk,files
Author: hundredvisionsguy
Author-email: cwinikka@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: docs
Requires-Dist: Sphinx (==4.2.0) ; extra == "docs"
Requires-Dist: autodoc (>=0.5.0,<0.6.0)
Requires-Dist: autoflake8 (>=0.3.2,<0.4.0)
Requires-Dist: black (>=22.6.0,<23.0.0)
Requires-Dist: bs4 (>=0.0.1,<0.0.2)
Requires-Dist: isort (>=5.10.1,<6.0.0)
Requires-Dist: mkdocs (>=1.3.1,<2.0.0)
Requires-Dist: mkdocs-awesome-pages-plugin (>=2.7.0,<3.0.0)
Requires-Dist: mkdocs-enumerate-headings-plugin (>=0.5.0,<0.6.0)
Requires-Dist: mkdocs-git-authors-plugin (>=0.6.4,<0.7.0)
Requires-Dist: mkdocs-git-revision-date-localized-plugin (>=1.1.0,<2.0.0)
Requires-Dist: mkdocs-img2fig-plugin (>=0.9.3,<0.10.0)
Requires-Dist: mkdocs-material (>=8.3.9,<9.0.0)
Requires-Dist: mkdocs-minify-plugin (>=0.5.0,<0.6.0)
Requires-Dist: mkdocs-print-site-plugin (>=2.3.4,<3.0.0)
Requires-Dist: mkdocs-table-reader-plugin (>=1.1.0,<2.0.0)
Requires-Dist: mkdocstrings (>=0.19.0,<0.20.0)
Requires-Dist: mkdocstrings-python (>=0.7.1,<0.8.0)
Requires-Dist: mkgendocs (>=0.9.1,<0.10.0)
Requires-Dist: mknotebooks (>=0.7.1,<0.8.0)
Requires-Dist: nltk (>=3.7,<4.0)
Requires-Dist: pip-licenses (>=3.5.4,<4.0.0)
Requires-Dist: pre-commit (>=2.20.0,<3.0.0)
Requires-Dist: pyrsistent (>=0.18.1,<0.19.0)
Requires-Dist: sphinx-rtd-theme (==1.0.0) ; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon (==0.7) ; extra == "docs"
Requires-Dist: tqdm (>=4.64.0,<5.0.0)
Project-URL: Documentation, https://hundredvisionsguy.github.io/file-clerk/
Project-URL: Repository, https://github.com/HundredVisionsGuy/file-clerk
Description-Content-Type: text/x-rst

file-clerk
==========

A collection of functions for dealing with files and file content.

This was a library I created for previous projects that deal with files
and file paths in order to get code from files, lists of files in
project folders, file extensions, and allows us to capture just files
of a particular type. I also developed my projects on Windows OS, so
these functions were designed to work with the file paths on Windows,
Mac, and Linux (Windows is the one with backslashes - wacky, I know.).

Typical usage example:
----------------------

:code:`extension = get_file_type("path/to/file.js")`

:code:`code_string = file_to_string("path/to/file.html")`

:code:`project_path = "path/to/project"`
:code:`all_project_files = get_all_project_files(project_path)`
:code:`just_css_files = get_all_files_of_type(project_path, "css")`

