Metadata-Version: 2.4
Name: smartdirs
Version: 0.0.2
Summary: 📂 System Directories and Utilities
Project-URL: GitHub, https://github.com/BrokenSource/SmartDirs
License-Expression: MIT
Requires-Python: >=3.10
Requires-Dist: pydantic
Description-Content-Type: text/markdown

> [!IMPORTANT]
> Work in progress, will roughly follow [`crates/directories`](https://crates.io/crates/directories), internal dogfooding for now.

<div align="center">
  <h1>SmartDirs</h1>
  <span>📂 System Directories and Utilities 📂</span>
  <br><br>
  <a href="https://pypi.org/project/smartdirs/"><img src="https://img.shields.io/pypi/v/smartdirs?label=PyPI&color=blue"></a>
  <a href="https://pypi.org/project/smartdirs/"><img src="https://img.shields.io/pypi/dw/smartdirs?label=%E2%86%93&color=blue"></a>
</div>

## 📦 Description

A modular platform directories package with conveniences:

- **Resources**: Get your package root or resources directories too
- **Re-exports** `pathlib.Path` for a single import line (wow!)
- **Workspace**: Easily set a root for base, user, site directories

## 📦 Usage

```python
# file: appname/__init__.py
from smartdirs import Path, SmartDirs

dirs = SmartDirs(
    package=Path(__file__).parent,
    name=str(__package__),
)
```

```python
# file: appname/main.py
import appname

# Access paths
appname.dirs.user_data
appname.dirs.resources
```
