semvec/pypi-packages huggingface dataset:
df-jupyter-magic 0.0.21
Magic commands to get file usage from python function shutil.disk_usage().
License: BSD 3-Clause License
Requires Python: >=3.6

# df_jupyter_magic

`%df` magic commands to get file usage within JupyterLab notebook. This package utilizes python function `shutil.disk_usage()`.

## Requirements

- JupyterLab >= 3.0
- Python >= 3.6

## Install

To install this package, execute:
```
pip install df-jupyter-magic
```

## Uninstall
To remove the package, execute:
```
pip uninstall df-jupyter-magic
```

## How to Use
You must first import the package by running following command:
```python
import df_jupyter_magic
```

Then, you may use one of the following commands:

- `%df` returns a human readable string in GB. Input is the path to the disk/partition. 
- `%df --raw` returns a raw data object.
- `%df --on` returns rsults in a string in GB after every subsequent cell run.
- `%df --off` turns off `on`.
- `%df -p /` sets the path to the partition to check.
- `%df -v` prints off additional text for debugging.