ak_file 0.0.3

File Parsing function

ak-file

A base module to manipulate files and folders

View Demo · Documentation · Report Bug · Request Feature

Table of Contents

• 1. About the Project
  • 1.1. Features
• 2. Getting Started
  • 2.1. Dependencies
  • 2.2. Installation
• 3. Usage
• 4. License
• 5. Contact
• 6. Acknowledgements

1. About the Project

A base project to simplify file manipulation

1.1. Features

• Can sanitize filename based on windows limitaions
• Can search for and return files with specified filenames

2. Getting Started

2.1. Dependencies

The repo comes pre-compiled with all dependencies.

2.2. Installation

Install from pypi

python -m venv .venv

venv\Scripts\activate.bat

pip install ak_file

3. Usage

import ak_file
file = ak_file.File("<path/to/file>")
file.exists()

file.properties()

To sanitize filename

from ak_file import sanitize
sanitize("Dirty_windows_file_name.ext")

To search for files with extension

from ak_file import search
search.by_extension(folder_path="Folder\path", extension="py", search_subdir=True)

4. License

See LICENSE.txt for more information.

5. Contact

Arun Kishore - @rpakishore

Project Link: https://github.com/rpakishore/ak-file

6. Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Awesome README Template
• Banner Maker
• Shields.io
• Carbon