dirlib

Name	dirlib JSON
Version	1.2.0 JSON
	download
home_page	https://github.com/owlinux1000/dirlib
Summary
upload_time	2022-12-18 12:40:19
maintainer
docs_url	None
author	owlinux1000
requires_python	>=3.10,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # dirlib

`dirlib` is a minimum library for getting a directory that is used by putting on configuration files. This is inspired by Golang standard library function called `os.UserConfigDir()`. Currently, Windows, Unix and macOS are supported.

## Installation

```
pip install dirlib
```

## How to use

```python
import dirlib

# On Windows
print(dirlib.user_config_dir()) #=> %AppData% or %UserProfile%

# On Unix
print(dirlib.user_config_dir()) #=> $XDG_CONFIG_HOME or $HOME/.config

# On macOS
print(dirlib.user_config_dir()) #=> $HOME/Libary/Application Support
```

`user_config_dir()` can pass the two arguments. The first one is an application name. Here is an example on Windows.

```python
import dirlib
app_name = "mysupercooltool"
print(dirlib.user_config_dir(app_name)) #=> C:\Users\chihiro\AppData\Roaming\mysupercooltool
```
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/owlinux1000/dirlib",
    "name": "dirlib",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "owlinux1000",
    "author_email": "encry1024@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b7/2e/827015ff4f380df34dc66b9cd20374617180a9188927331c468a7c1ba56c/dirlib-1.2.0.tar.gz",
    "platform": null,
    "description": "# dirlib\n\n`dirlib` is a minimum library for getting a directory that is used by putting on configuration files. This is inspired by Golang standard library function called `os.UserConfigDir()`. Currently, Windows, Unix and macOS are supported.\n\n## Installation\n\n```\npip install dirlib\n```\n\n## How to use\n\n```python\nimport dirlib\n\n# On Windows\nprint(dirlib.user_config_dir()) #=> %AppData% or %UserProfile%\n\n# On Unix\nprint(dirlib.user_config_dir()) #=> $XDG_CONFIG_HOME or $HOME/.config\n\n# On macOS\nprint(dirlib.user_config_dir()) #=> $HOME/Libary/Application Support\n```\n\n`user_config_dir()` can pass the two arguments. The first one is an application name. Here is an example on Windows.\n\n```python\nimport dirlib\napp_name = \"mysupercooltool\"\nprint(dirlib.user_config_dir(app_name)) #=> C:\\Users\\chihiro\\AppData\\Roaming\\mysupercooltool\n```",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "",
    "version": "1.2.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "620e217bad56c122c4a5a414bd1dc65b",
                "sha256": "b6d68ed46d4d17af167a18148cbeb23128275c2f9e46eac4d1accf7849d4a077"
            },
            "downloads": -1,
            "filename": "dirlib-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "620e217bad56c122c4a5a414bd1dc65b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 2689,
            "upload_time": "2022-12-18T12:40:18",
            "upload_time_iso_8601": "2022-12-18T12:40:18.485080Z",
            "url": "https://files.pythonhosted.org/packages/ad/30/9f1d9a9a626f41b65e5db9e5ad0daeff68a7c3bedb8c9d8c73032c08124b/dirlib-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "dc9cddd4bb41157988d1966b1969ffe8",
                "sha256": "ab2964afb51b7f6ccc596ad904f5e8beb2a0f7bcec5787f4055fa5d28b668acb"
            },
            "downloads": -1,
            "filename": "dirlib-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "dc9cddd4bb41157988d1966b1969ffe8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 2649,
            "upload_time": "2022-12-18T12:40:19",
            "upload_time_iso_8601": "2022-12-18T12:40:19.909366Z",
            "url": "https://files.pythonhosted.org/packages/b7/2e/827015ff4f380df34dc66b9cd20374617180a9188927331c468a7c1ba56c/dirlib-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-18 12:40:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "owlinux1000",
    "github_project": "dirlib",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "dirlib"
}