{ "info": { "author": "D-Wave Systems Inc.", "author_email": "oshklarsky@dwavesys.com", "bugtrack_url": null, "classifiers": [], "description": "[![Coverage Status](https://coveralls.io/repos/github/dwavesystems/homebase/badge.svg?branch=master)](https://coveralls.io/github/dwavesystems/homebase?branch=master)\n[![Build Status](https://travis-ci.org/dwavesystems/homebase.svg?branch=master)](https://travis-ci.org/dwavesystems/homebase)\n[![Documentation Status](https://readthedocs.org/projects/homebase/badge/?version=latest)](http://homebase.readthedocs.io/en/latest/?badge=latest)\n# homebase\n\n\nA place for your app to call home.\n\n*homebase* provides a platform independent API for querying paths in which applications can write caches, data, configs, and\nother information.\n\n\n## rationale \n\nSince each operating system expects applications to write their data to OS dependant paths, managing cache writing\non portable applications can become difficult.\n\nFor example, on macOS:\n\n ~/Library/Application Support/app_name\n\nwhile on Linux it may be:\n\n ~/.local/share/app_name\n\nand on Windows:\n\n c:\\users\\\\AppData\\Local/app_name\n\nand the problem gets worse if you are running inside of a [virtualenv](https://virtualenv.pypa.io/en/stable/)\n\nA similar issue happens for other forms of data, like caches, logs, configuration files, or application state.\n\n## Installation\n\n```bash\npython setup.py install\n```\n\n\n## Usage\n\n```python\nimport homebase\n\napp_name = \"my_app\"\napp_author = \"nakatomi-corp\"\nuser_data_dir = homebase.user_data_dir(app_name=app_name, app_author=app_author)\nuser_cache_dir = homebase.user_cache_dir(app_name=app_name, app_author=app_author)\nuser_logs_dir = homebase.user_logs_dir(app_name=app_name, app_author=app_author)\nuser_config_dir = homebase.user_config_dir(app_name=app_name, app_author=app_author)\nuser_state_dir = homebase.user_state_dir(app_name=app_name, app_author=app_author)\n\n# site specific directories, e.g. /usr/share\nsite_data_dir = homebase.site_data_dir(app_name=app_name, app_author=app_author)\nsite_config_dir = homebase.site_config_dir(app_name=app_name, app_author=app_author)\n```\n\nIf you are running inside of a virtualenv, *homebase* will return paths that are relative to that environment.\nIf you still want the user path, pass `use_virtualenv=False` in the call.\n\nFor example, suppose you have set up a virtual environment in `/home/username/env` on linux\n\n```python\nimport homebase\n\napp_name = \"my_app\"\napp_author = \"nakatomi-corp\"\nuser_data_dir = homebase.user_data_dir(app_name=app_name, app_author=app_author)\n# /home/username/env/data/my_app\nuser_data_dir = homebase.user_data_dir(app_name=app_name, app_author=app_author, use_virtualenv=False)\n# /home/username/.local/share/my_app.\n```\n\nSee the [documentation](# TODO) for more details and examples.\n\n## License\n\nSee [LICENSE.txt](LICENSE.txt)\n\n\n## Acknowledgement\n\nThis project is inspired by and is derived from [appdirs](https://github.com/ActiveState/appdirs)\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/dwavesystems/homebase/archive/1.0.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dwavesystems/homebase", "keywords": "", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "homebase", "package_url": "https://pypi.org/project/homebase/", "platform": "", "project_url": "https://pypi.org/project/homebase/", "project_urls": { "Download": "https://github.com/dwavesystems/homebase/archive/1.0.1.tar.gz", "Homepage": "https://github.com/dwavesystems/homebase" }, "release_url": "https://pypi.org/project/homebase/1.0.1/", "requires_dist": [ "enum34 (<2.0.0,>=1.1.6); python_version <= \"3.3\"" ], "requires_python": "", "summary": "A platform independent API for paths in which applications can write data.", "version": "1.0.1" }, "last_serial": 4118141, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "421034321595119fadabad56292e4a50", "sha256": "a7bbdfdd48f587a3ce0b4a78a56479943b401671840e1d44af115746d4239350" }, "downloads": -1, "filename": "homebase-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "421034321595119fadabad56292e4a50", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13083, "upload_time": "2017-12-14T21:04:15", "url": "https://files.pythonhosted.org/packages/30/2d/67f743b64c78a330f4e0b6cef72c82aa57bf1951a36e304d1293478ae5bc/homebase-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "93e7cb244de46b41331a4ffa6f365edc", "sha256": "28d05da883de3884e7b08e23b414061fed822552f3f793700bc14d90ea8061e9" }, "downloads": -1, "filename": "homebase-1.0.0.tar.gz", "has_sig": false, "md5_digest": "93e7cb244de46b41331a4ffa6f365edc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11764, "upload_time": "2017-12-14T21:04:19", "url": "https://files.pythonhosted.org/packages/e2/60/27e7c4fbe9b0285157a736b05d201566f565e7220bba4c56994d29bf372c/homebase-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "7fb400940c089564c1c6e88ab32575a8", "sha256": "d64c97f60a8ddd94ce8702bac65ed5d1996aca01a17d1e53e6ad5149e2f8b5b5" }, "downloads": -1, "filename": "homebase-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7fb400940c089564c1c6e88ab32575a8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11307, "upload_time": "2018-07-30T22:48:51", "url": "https://files.pythonhosted.org/packages/50/ad/e0080c35bd177682d5118a95bc2e7c1ac0541394b4ffce5e9554b6a077f9/homebase-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8e8f8913aecb93ee4e12ccc180fae6d2", "sha256": "9ee008df4298b420852d815e6df488822229c4bd8d571bcd0a454e04232c635e" }, "downloads": -1, "filename": "homebase-1.0.1.tar.gz", "has_sig": false, "md5_digest": "8e8f8913aecb93ee4e12ccc180fae6d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11848, "upload_time": "2018-07-30T22:48:52", "url": "https://files.pythonhosted.org/packages/a5/fa/55afcae0026285dc51792e5959b3667a246fd5cb82e97211f2267d52b3ac/homebase-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7fb400940c089564c1c6e88ab32575a8", "sha256": "d64c97f60a8ddd94ce8702bac65ed5d1996aca01a17d1e53e6ad5149e2f8b5b5" }, "downloads": -1, "filename": "homebase-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7fb400940c089564c1c6e88ab32575a8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11307, "upload_time": "2018-07-30T22:48:51", "url": "https://files.pythonhosted.org/packages/50/ad/e0080c35bd177682d5118a95bc2e7c1ac0541394b4ffce5e9554b6a077f9/homebase-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8e8f8913aecb93ee4e12ccc180fae6d2", "sha256": "9ee008df4298b420852d815e6df488822229c4bd8d571bcd0a454e04232c635e" }, "downloads": -1, "filename": "homebase-1.0.1.tar.gz", "has_sig": false, "md5_digest": "8e8f8913aecb93ee4e12ccc180fae6d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11848, "upload_time": "2018-07-30T22:48:52", "url": "https://files.pythonhosted.org/packages/a5/fa/55afcae0026285dc51792e5959b3667a246fd5cb82e97211f2267d52b3ac/homebase-1.0.1.tar.gz" } ] }