# pyrfs

> Pythonic filesystem ergonomics inspired by R's fs — tidy paths, typed values, chainable, pandas-friendly

pyrfs is a Python filesystem library porting the UX of R's fs package: consistent noun_verb naming (path_*, file_*, dir_*, link_*), tidy paths, typed self-describing values (FsPath, Bytes, Perms), explicit failure, and three interchangeable surfaces — functional, fluent FsPath chaining, and a pandas Series accessor with typed DataFrame columns.

## Start here

- [Home](https://pyrfs.netlify.app/index.md): Install and the three surfaces in one screen
- [Coming from R's fs](https://pyrfs.netlify.app/coming-from-r/index.md): R fs to pyrfs translation table and differences

## Guides

- [Safety & errors](https://pyrfs.netlify.app/guides/safety-and-errors/index.md)
- [The three surfaces](https://pyrfs.netlify.app/guides/three-surfaces/index.md)
- [Typed values](https://pyrfs.netlify.app/guides/typed-values/index.md)

## API reference

- [Directories](https://pyrfs.netlify.app/api/dirs/index.md)
- [Files](https://pyrfs.netlify.app/api/files/index.md)
- [FsPath](https://pyrfs.netlify.app/api/fspath/index.md)
- [Info, temp & errors](https://pyrfs.netlify.app/api/info-temp-errors/index.md)
- [Links](https://pyrfs.netlify.app/api/links/index.md)
- [Path algebra](https://pyrfs.netlify.app/api/paths/index.md)
- [Predicates & ids](https://pyrfs.netlify.app/api/predicates-ids/index.md)
- [Bytes & Perms](https://pyrfs.netlify.app/api/values/index.md)

## Design notes

- [UX design](https://pyrfs.netlify.app/design/pyrfs-ux/index.md): UX design document
- [Architecture](https://pyrfs.netlify.app/design/pyrfs-architecture/index.md): Architecture document

## Project

- [Changelog](https://pyrfs.netlify.app/changelog/index.md): Release history