Pistachio aims to simplify reoccurring tasks when working with the file system.
Project description
pistachio
Pistachio aims to simplify reoccurring tasks when working with the file system.
Developing
To install pistachio, along with the tools you need to develop and run tests, run the following in your virtualenv:
$ python -m venv env
$ source /env/bin/activate
$ pip install flit
$ flit install
Install
You can install pistachio by running the following command.
$ pip install pistachio
Usage
To use pistachio you can inport the module by running the following commands.
>>> import pistachio
Describe
Method to return a description for the resource.
>>> pistachio.describe("README.md")
Pistachio(path='README.md', exists=True, is_directory=False, is_file=True, is_symlink=False, name='README.md', stem='README', suffix='md')
Exists
You can confirm if a directory, file or symbolic link exists using the following method.
>>> pistachio.exists("README.md")
True
Get MD5 Hash
This method will return the MD5 hash string for a specific file.
>>> pistachio.get_md5_hash("README.md")
"2f853812babf98322618edeb24359591"
Is Directory
Is the resource a directory? True or False.
>>> pistachio.is_directory("README.md")
False
Is File
Is the resource a file? True or False.
>>> pistachio.is_file("README.md")
True
Is Symlink
Is the resource a symbolic link? True or False.
>>> pistachio.is_symlink("README.md")
False
Make a Symlink
Make a new symbolic link.
>>> pistachio.ln("README.txt", "README.md")
False
Make a Directory
Make a new directory or directory tree.
>>> pistachio.mkdir("src")
>>> pistachio.exists("src")
True
Touch
This method will create an empty file with a given filename and directory path.
>>> pistachio.touch("foo.bar")
True
Tree
This method will return a list of directories, files and symlinks below a specific directory.
>>> pistachio.tree("src")
Tree(path='pistachio', results=[Pistachio(path='./__init__.py', exists=True, is_directory=False, is_file=True, is_symlink=False, name='__init__.py', stem='__init__', suffix='py')])
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pistachio-0.7.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 638bd6ac060184267af2ec2aa74630ee0db229a0ccfa7fd9fca6af7042492bcf |
|
MD5 | ea682ef905170ac054244bb2e99d5794 |
|
BLAKE2b-256 | 8d2da0f6411a12f8eeb947b2c31d33f62bcfaf03c50f028434fba21f1b66ff55 |