{
    "info": {
        "author": "Aaron Knight",
        "author_email": "iamaaronknight@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Onde\n\nOnde ('OWN-jee') is a simple Python tool for naming and referencing file and directory paths meaningfully.\n\n\n## Usage\nInstall Onde with pip:\n\n`pip install onde`\n\nTo use Onde, create a YAML file named `paths.yml` in the root directory of your project that maps important files and directories to convenient aliases that you can use to refer to those files.\n\n\n**paths.yml**\n```yaml\n- some_alias:\n  - \"/some_absolute_path/some_file.txt\"\n- another_alias:\n  - \"some_relative_path/another_file.txt\"\n- A third alias:\n  - \"~/some_folder/a_file.txt\"\n```\n\nYou then use Onde by instantiating it and calling `paths`:\n\n```python\n>>> from onde import Onde\n\n>>> onde = Onde()\n\n>>> onde.path('some_alias')\n'/some_absolute_path/some_file.txt'\n\n>>> onde.path('another_alias')\n'some_relative_path/another_file.txt'\n\n>>> onde.path('A third alias')\n'/Users/myusername/some_folder/a_file.txt'\n```\n\n\nPaths can include variables, which are wrapped in curly braces. When calling `paths()` you can fill in the variables:\n\n**paths.yml**\n```yaml\n- my_alias:\n  - path: \n    - \"/{my_directory}/{my_file}.txt\"\n```\n\n```python\n>>> from onde import Onde\n\n>>> Onde().path('my_alias', 'hey_there', my_file='hows_it_going')\n'/hey_there/hows_it_going.txt'\n```\n\nDirectories can be nested, to make it easy to refer to represent multiple significant locations within a file system:\n\n**paths.yml**\n```yaml\n - top_level: \n   - \"some/folder\"\n   - thing1: \n     - \"path/to/child_1\"\n   - thing2: \n     - \"path/to/child_2\"\n     - deeply_embedded_thing: \n       - \"deeply/embedded/thing.txt\"\n```\n\n```python\n>>> from onde import Onde\n\n>>> onde = Onde()\n\n>>> onde.path('top_level')\n'some/folder'\n\n>>> onde.path('thing1')\n'some/folder/path/to/child1'\n\n>>> onde.path('thing2')\n'some/folder/path/to/child2'\n\n>>> onde.path('deeply_embedded_thing')\n'some/folder/path/to/child2/deeply/embedded/thing.txt'\n```\n\n\nAliases must be unique within the paths YAML file. Attempting to import a YAML file with duplicate aliases will raise an exception.\n\nPath variables must also be unique for each path.\n\nA well-formed Onde paths file should be in the format:\n```yaml\n- alias:\n  - 'path_segment'\n  - child_alias:\n    - 'path_segment'\n  - child_alias:\n    - 'path_segment'\n```\n\nEach mapping has a single alias as its key and a list as the value of that key. The first item in the list is a  \n\n\n## Contributing\nPull requests are welcome!\n\nTo install: `python setup.py install`\nTo run tests: `python setup.py test`\n\n## License\nOnde is written by Aaron Knight <iamaaronknight@gmail.com>.  It is released\nunder the MIT license. See the LICENSE.txt file for more details.\n\n\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/phrasemix/onde",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "onde",
        "package_url": "https://pypi.org/project/onde/",
        "platform": "",
        "project_url": "https://pypi.org/project/onde/",
        "project_urls": {
            "Homepage": "https://github.com/phrasemix/onde"
        },
        "release_url": "https://pypi.org/project/onde/0.1.1/",
        "requires_dist": [
            "pyyaml"
        ],
        "requires_python": "",
        "summary": "A tool for giving meaningful names to file and directory paths",
        "version": "0.1.1"
    },
    "last_serial": 2907589,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4649f6f57d813e439abd690f12ae5d74",
                    "sha256": "30318b26d100266d7a27e7c311c5f2d391fc6464de5a8d2c7893a26b4b0d12fd"
                },
                "downloads": -1,
                "filename": "onde-0.1-py2.7.egg",
                "has_sig": false,
                "md5_digest": "4649f6f57d813e439abd690f12ae5d74",
                "packagetype": "bdist_egg",
                "python_version": "2.7",
                "requires_python": null,
                "size": 6554,
                "upload_time": "2017-05-29T18:48:55",
                "url": "https://files.pythonhosted.org/packages/dc/07/531739c6322a16b38d2b72466a4d91357bce341661173a699714b3d17839/onde-0.1-py2.7.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "66d370e99dd36315d544f9a77e36eae0",
                    "sha256": "2c1d878506fe76c14d6d4f745179f072f93065481405393881cc0ee4267b3630"
                },
                "downloads": -1,
                "filename": "onde-0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "66d370e99dd36315d544f9a77e36eae0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5911,
                "upload_time": "2017-05-29T18:48:54",
                "url": "https://files.pythonhosted.org/packages/9f/93/d6e144b349a6833a56a87e3318d5bed36be65ded063acd0677f9a6e04ea0/onde-0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "995abee13baf91b820038e4f5113eaec",
                    "sha256": "ae06ab15129b1ada9e4ed62c313ceda4418028536bcf2981cad32527ff6e3e74"
                },
                "downloads": -1,
                "filename": "onde-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "995abee13baf91b820038e4f5113eaec",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4842,
                "upload_time": "2017-05-29T18:48:57",
                "url": "https://files.pythonhosted.org/packages/ba/32/d1a4355dcc936e3165b4c2f5e432fe442efc81062cf49c02ecc5d370b26f/onde-0.1.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "934d5babe4aec4cb08875e7f8a28599a",
                    "sha256": "6ad5c952bf465f55cd02e7a044a133651aaf45381d85214e75d7e0ac9ee07f1c"
                },
                "downloads": -1,
                "filename": "onde-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "934d5babe4aec4cb08875e7f8a28599a",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5941,
                "upload_time": "2017-05-29T21:20:33",
                "url": "https://files.pythonhosted.org/packages/2c/8b/721182e24676eea9b0f2e654ead3d3b4bd9cbd8e9a4398e7dd93f2b12b42/onde-0.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f7198cbb27f89cf2a3b13a2b65d5b2f2",
                    "sha256": "175bbfa9f0a0b59f084f0cb423ed812c03d25c939d74b6b6a7a841ea5b61b9a4"
                },
                "downloads": -1,
                "filename": "onde-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f7198cbb27f89cf2a3b13a2b65d5b2f2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4851,
                "upload_time": "2017-05-29T21:20:34",
                "url": "https://files.pythonhosted.org/packages/09/d6/93ff709dbc7628c6cef5f182f00c19cca9f20b185df22c3bc47ae3cf0cf2/onde-0.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "934d5babe4aec4cb08875e7f8a28599a",
                "sha256": "6ad5c952bf465f55cd02e7a044a133651aaf45381d85214e75d7e0ac9ee07f1c"
            },
            "downloads": -1,
            "filename": "onde-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "934d5babe4aec4cb08875e7f8a28599a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5941,
            "upload_time": "2017-05-29T21:20:33",
            "url": "https://files.pythonhosted.org/packages/2c/8b/721182e24676eea9b0f2e654ead3d3b4bd9cbd8e9a4398e7dd93f2b12b42/onde-0.1.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f7198cbb27f89cf2a3b13a2b65d5b2f2",
                "sha256": "175bbfa9f0a0b59f084f0cb423ed812c03d25c939d74b6b6a7a841ea5b61b9a4"
            },
            "downloads": -1,
            "filename": "onde-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f7198cbb27f89cf2a3b13a2b65d5b2f2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4851,
            "upload_time": "2017-05-29T21:20:34",
            "url": "https://files.pythonhosted.org/packages/09/d6/93ff709dbc7628c6cef5f182f00c19cca9f20b185df22c3bc47ae3cf0cf2/onde-0.1.1.tar.gz"
        }
    ]
}