Skip to main content

Cross-platform access to a user's special folders

Project 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.

A quick usage example:

# 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. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

userpaths-0.1.3.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

userpaths-0.1.3-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file userpaths-0.1.3.tar.gz.

File metadata

  • Download URL: userpaths-0.1.3.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.0.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

File hashes

Hashes for userpaths-0.1.3.tar.gz
Algorithm Hash digest
SHA256 970792ad90675915e28aec35a1321cfa0b7ed7db56f64b7238c30635b7fd2bc4
MD5 77e20c8011b99ea969a1a315107e68e5
BLAKE2b-256 ad77e8a40656a03bfe0a7aa03c31a6997d6fe10f831ee87db4f6210b4c24e811

See more details on using hashes here.

File details

Details for the file userpaths-0.1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: userpaths-0.1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.0.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

File hashes

Hashes for userpaths-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 47e9355651f654c7f7cdf6a2439f5d863c9cea22f2325667ab4a4b913fff89ce
MD5 1c5991e6d5be00461b11977e3181c88c
BLAKE2b-256 0687b156917045cf2bc0b7ec52604b5508b70b2bc5fab137274163b537ebcd46

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page