Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexdelorenzo/app_paths
📂 Like appdirs, but with pathlib, path creation and async support.
https://github.com/alexdelorenzo/app_paths
Last synced: about 1 month ago
JSON representation
📂 Like appdirs, but with pathlib, path creation and async support.
- Host: GitHub
- URL: https://github.com/alexdelorenzo/app_paths
- Owner: alexdelorenzo
- License: lgpl-3.0
- Created: 2021-07-14T23:26:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T09:49:18.000Z (about 1 year ago)
- Last Synced: 2024-09-20T11:35:57.056Z (about 2 months ago)
- Language: Python
- Homepage: https://alexdelorenzo.dev
- Size: 42 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Get and create paths for your app
`app_paths` builds upon [`appdirs`](https://pypi.org/project/appdirs/) and automatically creates canonical file system paths for storing app and user data on Windows, macOS, Linux and *BSD.
Instead of just strings, `app_paths` gives developers `Path` objects from [`pathlib`](https://docs.python.org/3/library/pathlib.html) or [`aiopath`](https://github.com/alexdelorenzo/aiopath), and it handles path creation efficiently. It also adds [async support](https://www.python.org/dev/peps/pep-0492/).
This project uses [`📁 aiopath`](https://github.com/alexdelorenzo/aiopath) as an async [`pathlib`](https://docs.python.org/3/library/pathlib.html) replacement.
## Use case
First, let's take a look at [`appdirs`](https://pypi.org/project/appdirs/):
```python
from pathlib import Path
from appdirs import AppDirs
dirs = AppDirs('app', 'My Name', '0.1.0')
# appdirs will return uncreated paths as strings
user_data: str = dirs.user_data_dir
assert isinstance(user_data, str)
print(user_data) # '/home/user/.cache/app/0.1.0'
```
`appdirs` can generate paths as strings for an app. It does one thing, and it does that one thing well on multiple platforms.
```python3
user_data_path = Path(user_data)
# appdirs does not create paths
assert not user_data_path.exists()
```
However, it's up to app developers to handle creating paths on users' file systems. It's also up to developers to decide how they want to manipulate those paths, using abstractions like [`os.path`](https://docs.python.org/3/library/os.path.html), [`pathlib`](https://docs.python.org/3/library/pathlib.html) or [`aiopath`](https://github.com/alexdelorenzo/aiopath). Developers also have to think about how to efficiently perform path creation.
`app_paths` takes care of all of that for you.
`app_paths` automatically gives you [`pathlib.Path`](https://docs.python.org/3/library/pathlib.html) handles for your paths in synchronous apps, and [`aiopath.AsyncPath`](https://github.com/alexdelorenzo/aiopath) handles for async apps.
```python3
from app_paths import AppPaths
paths = AppPaths.get_paths('app', 'My Name', '0.1.0')
# app_paths can return paths
user_data: Path = paths.user_data_path
assert isinstance(user_data, Path)
print(user_data) # '/home/user/.cache/app/0.1.0'
```
`app_paths` can create paths on the file system dynamically, and it will cache results so excess I/O isn't performed.
```python3
# app_paths can return uncreated paths
assert not user_data.exists()
# but it can also dynamically create paths on the fly
user_data: Path = paths.user_data
assert user_data.exists()
```
It can do batch creation of app paths, and it will use efficient concurrent I/O in both synchronous and async Python programs.
```python3
# create user app paths concurrently
await paths.create_user()
# to run the following you must have write access to all paths
# create site app paths concurrently
await paths.create_site()
# create user and site paths concurrently
await paths.create_all()
```
Here's how you can do the above asynchronously:
```python3
from app_paths import AsyncAppPaths
from aiopath import AsyncPath
paths = await AsyncAppPaths.get_paths('app', 'My Name', '0.1.0')
# app_paths can return AsyncPaths
user_data: AsyncPath = paths.user_data_path
assert isinstance(user_data, AsyncPath)
print(user_data) # '/home/user/.cache/app/0.1.0'
# app_paths can return uncreated paths
assert not await user_data.exists()
# but it can also dynamically create paths on the fly
user_data: AsyncPath = await paths.user_data
assert await user_data.exists()
# create user app paths concurrently
await paths.create_user()
# to run the following you must have write access to all paths
# create site app paths concurrently
await paths.create_site()
# create user and site paths concurrently
await paths.create_all()
```
# Installation
## Requirements
- Windows, macOS or a POSIX compatible operating system
- Python 3.8+
## PyPI
```bash
$ python3 -m pip install app_paths
```
# Support
Want to support this project and [other open-source projects](https://github.com/alexdelorenzo) like it?
# License
See `LICENSE`. If you'd like to use this project with a different license, please get in touch.