Metadata-Version: 2.4
Name: rootly-sdk
Version: 0.1.0
Summary: Count free space on filesystem roots.
Project-URL: Homepage, https://github.com/github-artbrnv/rootly-sdk
Project-URL: Repository, https://github.com/github-artbrnv/rootly-sdk
Project-URL: Issues, https://github.com/github-artbrnv/rootly-sdk/issues
Author: Rootly SDK Contributors
License-Expression: MIT
License-File: LICENSE
Keywords: disk,filesystem,free-space,roots,storage
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: System :: Monitoring
Classifier: Typing :: Typed
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Description-Content-Type: text/markdown

# rootly-sdk

`rootly-sdk` is a small Python library to count free disk space on filesystem roots (drive roots on Windows, `/` on Unix-like systems).

## Installation

```bash
pip install rootly-sdk
```

## Quick Start

```python
from rootly_sdk import count_free_space, list_root_free_space

total_free_bytes = count_free_space()
per_root = list_root_free_space()

print(total_free_bytes)
print(per_root)
```

## CLI

After installation, use:

```bash
rootly-free-space
```

Example output:

```text
/ : 2241304576 bytes free
Total free space across roots: 2241304576 bytes
```

## Development

```bash
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest
```

## Publishing to PyPI

```bash
python -m pip install --upgrade build twine
python -m build
twine check dist/*
twine upload dist/*
```
