| .github/workflows | ||
| appdata | ||
| docs | ||
| tests | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| pytest.ini | ||
| README.md | ||
| requirements.txt | ||
| setup.py | ||
appdata | Application Data Management
Installation
pip install appdata
Documentation
The detailed documentation you can find on appdata.readthedocs.io.
Usage
To manage paths of application data folder there is AppDataPaths class:
from appdata import AppDataPaths
app_paths = AppDataPaths('myapp') # Name is optional. By default CWD folder name is used.
To create the application folder tree:
app_paths.setup()
There are few paths specified to manage your application data folder:
print(app_paths.name) # myapp
print(app_paths.app_data_path) # (for Linux and MacOS) /home/<user>/.myapp
print(app_paths.logs_path) # (for Linux and MacOS) /home/<user>/.myapp/logs
print(app_paths.config_path) # (for Linux and MacOS) /home/<user>/.myapp/default.ini
print(app_paths.log_file_path) # (for Linux and MacOS) /home/<user>/.myapp/logs/myapp.log
Every path could be customized. See options here.
Contributing
See CONTRIBUTING.md