Package: pathmagic
PLEASE NOTE:This library is currently still under development. The API will likely undergo significant changes that may break any code you write with it.
The documentation will fall out of sync with the updates regularly until development slows down. Use it at your own risk.OverviewPathmagic implements two classes,FileandDir, to represent mapped file system obects in a manner similar to database ORMs like sqlalchemy. These objects have properties which
perform file system operations when set, and implement many useful methods to abstract away nearly all file system I/O to a much higher degree thanos.pathorpathlib.TheDirclassProperties that perform rename and move operations when set (Dir.path,Dir.parent,Dir.name)Two accessor objects (Dir.files,Dir.dirs) which allow iteration over their respective   collections, item access, membership tests, and moreTwo specialized accessor objects (Dir.d,Dir.f), which dynamically populate themselves with snake_cased attributes that represent the files/folders in theirDir, such that
the filesystem tree can be traversed purely through attribute accessMethods to create new files/dirs, copy/move self to another path/dir, delete self or content, and join self to a relative pathRecursively walk the tree downwards, comparing own tree to a parallel filesystem treeRecursively seek files or dirs down the directory tree with inclusions/exclusions based on valid extensions and regex patterns matching name, path, and content.Compress self into a zipfileVisualize tree to arbitrary depth with an ascii representationInitialize from homepath, desktop, or packageTheFileclassProperties that perform rename and move operations when set (File.path,File.dir,File.name,File.stem,File.extension)Methods to copy/move self to another path/dir or delete selfInitialize from script entry point (in traditional interpreter), and from a package resourceFile.read()andFile.write()methods (and associatedFile.contentproperty) which invokes theFormatHandlerclass to determine how to read from/write to the file based
on its extension.FormatHandleruses the factory design pattern and can be extended at runtime to enableFileto handle types of files that are not supported by default.By default, recognized formats are the following:formatclass accepted/returnedfile extensionsPdfPyPDF2pdfTabularsubtypes.Framexlsx, csvWorddocx.DocumentdocxImagePIL.Imagepng, jpf, jpegAudiopydub.AudioSegmentmp3, wav, ogg, flvVideoMoviepy.editor.editmp4, mkv, avi, gifCompressedpathmagic.Dirzip, tarLinkpathmagic.File or pathmagic.DirlnkSerializedAnypklJsonAnyjsonMarkUpsubtypes.Markuphtml, xmlDefaultsubtypes.Streverything elseInstallationTo install use pip:$ pip install pathmagicOr clone the repo:$ git clone https://github.com/matthewgdv/pathmagic.git
$ python setup.py installUsageDetailed usage examples coming soon.ContributingContributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.You can contribute in many ways:Report BugsReport bugs athttps://github.com/matthewgdv/pathmagic/issuesIf you are reporting a bug, please include:Your operating system name and version.Any details about your local setup that might be helpful in troubleshooting.Detailed steps to reproduce the bug.Fix BugsLook through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.Implement FeaturesLook through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.Write DocumentationThe repository could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.Submit FeedbackThe best way to send feedback is to file an issue athttps://github.com/matthewgdv/pathmagic/issues.If you are proposing a new feature:Explain in detail how it would work.Keep the scope as narrow as possible, to make it easier to implement.Remember that this is a volunteer-driven project, and that contributions are welcome :)Get Started!Before you submit a pull request, check that it meets these guidelines:If the pull request adds functionality, it should include tests and the docs should be updated. Write docstrings for any functions that are part of the external API, and add
the feature to the README.md.If the pull request fixes a bug, tests should be added proving that the bug has been fixed. However, no update to the docs is necessary for bugfixes.The pull request should work for the newest version of Python (currently 3.7). Older versions may incidentally work, but are not officially supported.Inline type hints should be used, with an emphasis on ensuring that introspection and autocompletion tools such as Jedi are able to understand the code wherever possible.PEP8 guidelines should be followed where possible, but deviations from it where it makes sense and improves legibility are encouraged. The following PEP8 error codes can be
safely ignored: E121, E123, E126, E226, E24, E704, W503This repository intentionally disallows the PEP8 79-character limit. Therefore, any contributions adhering to this convention will be rejected. As a rule of thumb you should
endeavor to stay under 200 characters except where going over preserves alignment, or where the line is mostly non-algorythmic code, such as extremely long strings or function
calls.