# appdata | Application Data Management
[](https://coveralls.io/github/VoIlAlex/appdata?branch=master)
[](https://pypi.org/project/appdata/)
[](https://appdata.readthedocs.io/en/latest/)
[](https://codeclimate.com/github/VoIlAlex/appdata/maintainability)
[](https://www.python.org/)
[](https://github.com/VoIlAlex/appdata/blob/master/LICENSE.md)
[](https://pepy.tech/project/appdata)
[](https://svgshare.com/i/Zhy.svg)
[](https://svgshare.com/i/ZhY.svg)
[](https://svgshare.com/i/ZjP.svg)
## 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
app_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/default.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)
Raw data
{
"_id": null,
"home_page": "https://github.com/VoIlAlex/appdata",
"name": "appdata",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "utils,filesystem,paths,resources",
"author": "voilalex",
"author_email": "ilya.vouk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/56/07f5543ad4a07f9ff2aa4f306d6b3273974f129d37673a09675ec898fc9c/appdata-2.2.0.tar.gz",
"platform": null,
"description": "# appdata | Application Data Management\n\n[](https://coveralls.io/github/VoIlAlex/appdata?branch=master)\n[](https://pypi.org/project/appdata/)\n\n[](https://appdata.readthedocs.io/en/latest/)\n\n\n[](https://codeclimate.com/github/VoIlAlex/appdata/maintainability)\n[](https://www.python.org/)\n[](https://github.com/VoIlAlex/appdata/blob/master/LICENSE.md)\n[](https://pepy.tech/project/appdata)\n\n\n[](https://svgshare.com/i/Zhy.svg)\n[](https://svgshare.com/i/ZhY.svg)\n[](https://svgshare.com/i/ZjP.svg)\n\n## Installation\n\n```bash\npip install appdata\n```\n\n## Documentation\n\nThe detailed documentation you can find on [appdata.readthedocs.io](https://appdata.readthedocs.io/en/latest/index.html).\n\n## Usage\n\nTo manage paths of application data folder there is `AppDataPaths` class:\n\n```python\nfrom appdata import AppDataPaths\n\napp_paths = AppDataPaths('myapp') # Name is optional. By default CWD folder name is used.\n```\n\nTo create the application folder tree:\n\n```python\napp_paths.setup()\n```\n\nThere are few paths specified to manage your application data folder:\n\n```python\nprint(app_paths.name) # myapp\nprint(app_paths.app_data_path) # (for Linux) /home/<user>/.myapp\nprint(app_paths.logs_path) # (for Linux) /home/<user>/.myapp/logs\nprint(app_paths.config_path) # (for Linux) /home/<user>/.myapp/default.ini\nprint(app_paths.log_file_path) # (for Linux) /home/<user>/.myapp/logs/myapp.log\n```\n\nEvery path could be customized. See options [here](https://appdata.readthedocs.io/).\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## License\n\n[MIT](LICENSE.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Utils to manage application data folder.",
"version": "2.2.0",
"split_keywords": [
"utils",
"filesystem",
"paths",
"resources"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f80fc41ecdf4e802c7000f1b1ec460f8a14d4e820f97e6e98a133dd813e8c2d",
"md5": "1781c45933de5b0afd5c9907e45bfda5",
"sha256": "ebe435a951c9a1be7d4853e42cfe3b10e3c65135f09350768b8a4abd2f90b22f"
},
"downloads": -1,
"filename": "appdata-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1781c45933de5b0afd5c9907e45bfda5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7380,
"upload_time": "2023-01-25T10:47:39",
"upload_time_iso_8601": "2023-01-25T10:47:39.437497Z",
"url": "https://files.pythonhosted.org/packages/2f/80/fc41ecdf4e802c7000f1b1ec460f8a14d4e820f97e6e98a133dd813e8c2d/appdata-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "585607f5543ad4a07f9ff2aa4f306d6b3273974f129d37673a09675ec898fc9c",
"md5": "a6250a67ab86e3a08564802dcb453ca4",
"sha256": "b51f3b1b63c397906fb18f5ba931ed3e1ee87397c0ffdbe01662c91cefb928e9"
},
"downloads": -1,
"filename": "appdata-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a6250a67ab86e3a08564802dcb453ca4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6313,
"upload_time": "2023-01-25T10:47:40",
"upload_time_iso_8601": "2023-01-25T10:47:40.986794Z",
"url": "https://files.pythonhosted.org/packages/58/56/07f5543ad4a07f9ff2aa4f306d6b3273974f129d37673a09675ec898fc9c/appdata-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-25 10:47:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "VoIlAlex",
"github_project": "appdata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "appdata"
}
JSON
