The **userpaths** module provides cross-platform access to a user's special folders (or directories) like My Documents, Desktop, and Application Data. It is primarily intended to simplify development of desktop application software.
A quick usage example:
```python
# Get the user's My Documents folder
import userpaths
my_docs = userpaths.get_my_documents()
```
Both Python 2 and 3 are supported, on Windows and Unix platforms.
## API Reference
Function | Description
-------- | -----------
`get_appdata()` | Return the current user's roaming Application Data folder.
`get_desktop()` | Return the current user's Desktop folder.
`get_downloads()` | Return the current user's Downloads folder.
`get_local_appdata()` | Return the current user's local Application Data folder.
`get_my_documents()` | Return the current user's My Documents folder.
`get_my_music()` | Return the current user's My Music folder.
`get_my_pictures()` | Return the current user's My Pictures folder.
`get_my_videos()` | Return the current user's My Videos folder.
`get_profile()` | Return the current user's profile folder.
The userpaths API was inspired by, and is partly compatible with, Ryan Ginstrom's [winpaths](http://ginstrom.com/code/winpaths.html). However, userpaths is not intended as a direct replacement for that module.
## Compatibility Note
The userpaths module was originally designed from a Windows-centric perspective. Because of the many differences between the two systems, there are some Windows paths that do not have a direct equivalent on Unix, and vice versa. In these cases, userpaths attempts to return the nearest functional equivalent, but it is up to the user to ensure their application is using the appropriate path for what it seeks to do.
Raw data
{
"_id": null,
"home_page": "https://github.com/bmjcode/userpaths",
"name": "userpaths",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Benjamin Johnson",
"author_email": "bmjcode@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ad/77/e8a40656a03bfe0a7aa03c31a6997d6fe10f831ee87db4f6210b4c24e811/userpaths-0.1.3.tar.gz",
"platform": "",
"description": "The **userpaths** module provides cross-platform access to a user's special folders (or directories) like My Documents, Desktop, and Application Data. It is primarily intended to simplify development of desktop application software.\n\nA quick usage example:\n\n```python\n# Get the user's My Documents folder\nimport userpaths\nmy_docs = userpaths.get_my_documents()\n```\n\nBoth Python 2 and 3 are supported, on Windows and Unix platforms.\n\n\n## API Reference\n\nFunction | Description\n-------- | -----------\n`get_appdata()` | Return the current user's roaming Application Data folder.\n`get_desktop()` | Return the current user's Desktop folder.\n`get_downloads()` | Return the current user's Downloads folder.\n`get_local_appdata()` | Return the current user's local Application Data folder.\n`get_my_documents()` | Return the current user's My Documents folder.\n`get_my_music()` | Return the current user's My Music folder.\n`get_my_pictures()` | Return the current user's My Pictures folder.\n`get_my_videos()` | Return the current user's My Videos folder.\n`get_profile()` | Return the current user's profile folder.\n\nThe userpaths API was inspired by, and is partly compatible with, Ryan Ginstrom's [winpaths](http://ginstrom.com/code/winpaths.html). However, userpaths is not intended as a direct replacement for that module.\n\n\n## Compatibility Note\n\nThe userpaths module was originally designed from a Windows-centric perspective. Because of the many differences between the two systems, there are some Windows paths that do not have a direct equivalent on Unix, and vice versa. In these cases, userpaths attempts to return the nearest functional equivalent, but it is up to the user to ensure their application is using the appropriate path for what it seeks to do.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Cross-platform access to a user's special folders",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/bmjcode/userpaths"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0687b156917045cf2bc0b7ec52604b5508b70b2bc5fab137274163b537ebcd46",
"md5": "1c5991e6d5be00461b11977e3181c88c",
"sha256": "47e9355651f654c7f7cdf6a2439f5d863c9cea22f2325667ab4a4b913fff89ce"
},
"downloads": -1,
"filename": "userpaths-0.1.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c5991e6d5be00461b11977e3181c88c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6819,
"upload_time": "2019-09-02T18:48:01",
"upload_time_iso_8601": "2019-09-02T18:48:01.174779Z",
"url": "https://files.pythonhosted.org/packages/06/87/b156917045cf2bc0b7ec52604b5508b70b2bc5fab137274163b537ebcd46/userpaths-0.1.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad77e8a40656a03bfe0a7aa03c31a6997d6fe10f831ee87db4f6210b4c24e811",
"md5": "77e20c8011b99ea969a1a315107e68e5",
"sha256": "970792ad90675915e28aec35a1321cfa0b7ed7db56f64b7238c30635b7fd2bc4"
},
"downloads": -1,
"filename": "userpaths-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "77e20c8011b99ea969a1a315107e68e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4456,
"upload_time": "2019-09-02T18:48:02",
"upload_time_iso_8601": "2019-09-02T18:48:02.739553Z",
"url": "https://files.pythonhosted.org/packages/ad/77/e8a40656a03bfe0a7aa03c31a6997d6fe10f831ee87db4f6210b4c24e811/userpaths-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-09-02 18:48:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bmjcode",
"github_project": "userpaths",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "userpaths"
}
JSON
