Metadata-Version: 2.4
Name: ae_files
Version: 0.3.28
Summary: ae namespace module portion files: generic file object helpers
Home-page: https://gitlab.com/ae-group/ae_files
Author: AndiEcker
Author-email: aecker2@gmail.com
License: GPL-3.0-or-later
Project-URL: Bug Tracker, https://gitlab.com/ae-group/ae_files/-/issues
Project-URL: Documentation, https://ae.readthedocs.io/en/latest/_autosummary/ae.files.html
Project-URL: Repository, https://gitlab.com/ae-group/ae_files
Project-URL: Source, https://ae.readthedocs.io/en/latest/_modules/ae/files.html
Keywords: configuration,development,environment,productivity
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: ae_base
Provides-Extra: dev
Requires-Dist: aedev_project_tpls; extra == "dev"
Requires-Dist: ae_ae; extra == "dev"
Requires-Dist: anybadge; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: typing; extra == "dev"
Requires-Dist: types-setuptools; extra == "dev"
Provides-Extra: docs
Provides-Extra: tests
Requires-Dist: anybadge; extra == "tests"
Requires-Dist: flake8; extra == "tests"
Requires-Dist: mypy; extra == "tests"
Requires-Dist: pylint; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: typing; extra == "tests"
Requires-Dist: types-setuptools; extra == "tests"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.104 -->
<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.31 -->
# files 0.3.28

[![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_files/develop?logo=python)](
    https://gitlab.com/ae-group/ae_files)
[![LatestPyPIrelease](
    https://img.shields.io/gitlab/pipeline/ae-group/ae_files/release0.3.28?logo=python)](
    https://gitlab.com/ae-group/ae_files/-/tree/release0.3.28)
[![PyPIVersions](https://img.shields.io/pypi/v/ae_files)](
    https://pypi.org/project/ae-files/#history)

>ae namespace module portion files: generic file object helpers.

[![Coverage](https://ae-group.gitlab.io/ae_files/coverage.svg)](
    https://ae-group.gitlab.io/ae_files/coverage/index.html)
[![MyPyPrecision](https://ae-group.gitlab.io/ae_files/mypy.svg)](
    https://ae-group.gitlab.io/ae_files/lineprecision.txt)
[![PyLintScore](https://ae-group.gitlab.io/ae_files/pylint.svg)](
    https://ae-group.gitlab.io/ae_files/pylint.log)

[![PyPIImplementation](https://img.shields.io/pypi/implementation/ae_files)](
    https://gitlab.com/ae-group/ae_files/)
[![PyPIPyVersions](https://img.shields.io/pypi/pyversions/ae_files)](
    https://gitlab.com/ae-group/ae_files/)
[![PyPIWheel](https://img.shields.io/pypi/wheel/ae_files)](
    https://gitlab.com/ae-group/ae_files/)
[![PyPIFormat](https://img.shields.io/pypi/format/ae_files)](
    https://pypi.org/project/ae-files/)
[![PyPILicense](https://img.shields.io/pypi/l/ae_files)](
    https://gitlab.com/ae-group/ae_files/-/blob/develop/LICENSE.md)
[![PyPIStatus](https://img.shields.io/pypi/status/ae_files)](
    https://libraries.io/pypi/ae-files)
[![PyPIDownloads](https://img.shields.io/pypi/dm/ae_files)](
    https://pypi.org/project/ae-files/#files)



## installation

execute the following command to install the
ae.files module
in the currently active virtual environment:
 
```shell script
pip install ae-files
```

if you want to contribute to this portion then first fork
[the ae_files repository at GitLab](
https://gitlab.com/ae-group/ae_files "ae.files code repository").
after that pull it to your machine and finally execute the
following command in the root folder of this repository
(ae_files):

```shell script
pip install --editable .[dev]
```

this command installs this module portion project
along with the necessary tools to modify the source code,
run unit tests, and build documentation. to install only
the dependencies required for a specific task,  replace
`dev` with one of the following:

    * `tests`: for contributing to the unit test suite
    * `docs`: for maintaining and building documentation

more detailed explanations on how to contribute to this project
[are available here](
https://gitlab.com/ae-group/ae_files/-/blob/develop/CONTRIBUTING.rst)


## namespace portion documentation

the documentation of the source code of this portion is available at
[ReadTheDocs](
https://ae.readthedocs.io/en/latest/_autosummary/ae.files.html
"ae_files documentation").


