Metadata-Version: 2.1
Name: appdata
Version: 2.0.1
Summary: Utils to manage application data folder.
Home-page: https://github.com/VoIlAlex/appdata
Author: voilalex
Author-email: ilya.vouk@gmail.com
License: MIT
Download-URL: https://github.com/VoIlAlex/appdata/archive/v1.2.0.tar.gz
Keywords: utils,filesystem,paths,resources
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console :: Curses
Classifier: Topic :: Utilities
Classifier: Topic :: System :: Filesystems
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md

# appdata | Application Data Management

## Installation

```bash
pip install appdata
```

## Documentation

The detailed documentation you can find on [appdata.readthedocs.io](https://appdata.readthedocs.io/en/latest/index.html).

## Usage

To manage paths of application data folder there is `AppDataPaths` class:

```python
from appdata import AppDataPaths

app_paths = AppDataPaths('myapp')  # Name is optional. By default CWD folder name is used.
```

To create the application folder tree:

```python
paths.setup()
```

There are few paths specified to manage your application data folder:

```python
print(app_paths.name)  # myapp
print(app_paths.app_data_path)  # (for Linux) /home/<user>/.myapp
print(app_paths.logs_path)  # (for Linux) /home/<user>/.myapp/logs
print(app_paths.config_path)  # (for Linux) /home/<user>/.myapp/myapp.ini
print(app_paths.log_file_path)  # (for Linux) /home/<user>/.myapp/logs/myapp.log
```

Every path could be customized. See options [here](https://appdata.readthedocs.io/).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

[MIT](LICENSE.md)


