{
    "info": {
        "author": "Mateusz Konieczny",
        "author_email": "matkoniecz@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "OSM bot abstraction layer is a python package making easier to automate OSM edits without causing problems.\n\nThis projects contains code shared between OSM bots, to avoid writing the same functionality more than once.\n\nFor example, automated edit may change many objects across large area. In that case it is preferable to split it into multiple edits to avoid country-sized bounding boxes. This logic is available as one of tools included in this project.\n\n# Installation\n\n`pip install osm-bot-abstraction-layer`\n\n[![PyPI version](https://badge.fury.io/py/osm-bot-abstraction-layer.svg)](https://badge.fury.io/py/osm-bot-abstraction-layer)\n\n# Contributing\n\nFirst contact with any project is crucial, so please report any and all issues in this readme. If you needed tool like this but decided to not use it for some fixable reason - please open an issue!\n\nReports about how documentation can be improved, bug reports, pull requests are welcomed!\n\nPull requests are welcomed from smallest typo to big new features - though in case of huge changes it is always a good idea to start from opening an issue.\n\n# Purpose\n\nThis tool is for people who are at once\n\n- programmers\n- experienced OSM editors\n- following OSM rules\n\nAnyone who runs automated edits is responsible for all problems that appear, including ones caused bugs in external libraries like this one.\n\nI eliminated all bugs that I noticed, after all I am using this code myself, but some are still lurking. Issue reports and pull requests are welcomed!\n\n# Reminder about OSM rules\n\nNote that automated must not be done without consultation or agreement of a community.\n\nSee the [Import/Guidelines](http://wiki.openstreetmap.org/wiki/Import/Guidelines) and [Automated Edits/Code of Conduct](http://wiki.openstreetmap.org/wiki/Automated_Edits/Code_of_Conduct) for more information.\n\nNote that automated edits violating rules mentioned above are routinely undone. Undiscussed automatic edits may be reverted by anybody, without any consultation.\n\nAnd yes, it means that some automated edits that would save time and make perfect sense were rejected and should not be made. It is still preferable over unrestricted automateed edits.\n\n# Configuration\n\nCreate `secret.json` file with content like this:\n\n```\n{\n\t\"bot_account\": {\n\t\t\"username\": \"Your OSM username for a bot account\",\n\t\t\"password\": \"?6ofGZm=qr*skR?C,a,1E#k9g8:kE7\"\n\t},\n\t\"human_account\": {\n\t\t\"username\": \"Your OSM username for a human operated account\",\n\t\t\"password\": \"t?\\q~,?m;2l?Dd$cKc`?n9PeSDBjj/\"\n\t}\n}\n```\n\n# Usage example\n\nFollowing is example based on a real automated edit, following [guidelines for the automatic edits](https://wiki.openstreetmap.org/wiki/Automated_Edits_code_of_conduct).\n\n  1. Relevant community was asked. In this case it affected Polish mappers, so thread appeared [in Polish section of forum.openstreetmap.org](https://forum.openstreetmap.org/viewtopic.php?id=64421). Note that different communities may use different forums or mailing lists as their communication channels.\n  1. In addition [Page documenting the automated edit was created at OSM wiki](https://wiki.openstreetmap.org/wiki/Mechanical_Edits/Mateusz_Konieczny_-_bot_account/moving_%27name:botanical%27%3D%27Platanus_%C3%97_hispanica%27_to_species%3D%27Platanus_%C3%97_hispanica%27_for_natural%3Dtree_in_Poland).\n  1. OSM community accepted the edit.\n  1. Following code was created using `run_simple_retagging_task` component. Running this script will result in:\n  \t- downloading OSM data using Overpass Turbo as specified in `objects_to_consider_query` parameter\n  \t- iterate over all and objects, ignoring ones where function passed as parameter `is_element_editable_checker_function` returns false\n  \t- for all other `edit_element_function` is applied\n  \t- changes are automatically split in multiple changesets (if necessary) to avoid too large bounding boxes or too many objects in one edit\n  \t- `changeset_comment`, `discussion_url`, `osm_wiki_documentation_page` parameter values are used to apply correct changeset tags\n  1. Running this code resulted in two edits: [#64628901](https://www.openstreetmap.org/changeset/64628901) and [#64628951](https://www.openstreetmap.org/changeset/64628951)\n\n```\nfrom osm_bot_abstraction_layer.generic_bot_retagging import run_simple_retagging_task\n\ndef is_element_editable(tag_dictionary, identifier):\n    if tag_dictionary.get('name') == (\"bankomat\"):\n        return True\n    if tag_dictionary.get('name') == (\"Bankomat\"):\n        return True\n    return False\n\ndef edit_element(tags):\n    tags.pop('name', None)\n    return tags\n\ndef main():\n    run_simple_retagging_task(\n        max_count_of_elements_in_one_changeset=500,\n        objects_to_consider_query=\"\"\"\n[out:xml][timeout:25000];\narea[name=\"Polska\"]->.a;\n(\n  nwr[amenity='atm'][name='Bankomat'](area.a);\n  nwr[amenity='atm'][name='bankomat'](area.a);\n);\nout body;\n>;\nout skel qt;\n\"\"\",\n        objects_to_consider_query_storage_file='/media/mateusz/5bfa9dfc-ed86-4d19-ac36-78df1060707c/OSM-cache/overpass/tags_for_retagging_descriptive_atm.osm',\n        is_in_manual_mode=False,\n        changeset_comment='usuwanie nazw opisowych z bankomat\u00f3w (name=\"bankomat\" i name=\"Bankomat\")',\n        discussion_url='https://forum.openstreetmap.org/viewtopic.php?id=66038',\n        osm_wiki_documentation_page='https://wiki.openstreetmap.org/wiki/Mechanical_Edits/Mateusz_Konieczny_-_bot_account/fix_descriptive_name_on_ATMs_in_Poland',\n        is_element_editable_checker_function=is_element_editable,\n        edit_element_function=edit_element,\n    )\n\nmain()\n```\n\n# Further documentation\n\nDocumentation is currently mostly missing - please, open an issue if it would be useful for you (pull requests are also welcomed).\n\n# History and etymology\n\nParts of the project built upon [osmapi](https://github.com/metaodi/osmapi) and provide an additional abstraction layer. This part was initial and was source of the project name.\n\n# Project location\n\nThis project resides at [https://github.com/matkoniecz/osm_bot_abstraction_layer](https://github.com/matkoniecz/osm_bot_abstraction_layer)\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/matkoniecz/osm_bot_abstraction_layer",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "osm-bot-abstraction-layer",
        "package_url": "https://pypi.org/project/osm-bot-abstraction-layer/",
        "platform": "",
        "project_url": "https://pypi.org/project/osm-bot-abstraction-layer/",
        "project_urls": {
            "Homepage": "https://github.com/matkoniecz/osm_bot_abstraction_layer"
        },
        "release_url": "https://pypi.org/project/osm-bot-abstraction-layer/0.0.6/",
        "requires_dist": [
            "osmapi (<2.0,>=1.0.2)",
            "termcolor (<2.0,>=1.1.0)",
            "urllib3 (<2.0,>=1.13.1)",
            "osm-iterator (<2.0,>=1.1.0)"
        ],
        "requires_python": "",
        "summary": "A tool for easier automation of OSM edits without causing problems.",
        "version": "0.0.6"
    },
    "last_serial": 5346352,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "87dac61daac71515d7273477e12d2770",
                    "sha256": "6bf504eaa3738656abc166265d33f5e92f6b950a37e8782550372aa4e3403725"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "87dac61daac71515d7273477e12d2770",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9819,
                "upload_time": "2018-10-16T21:56:20",
                "url": "https://files.pythonhosted.org/packages/21/b2/20ebe691c0606964ed2b21b98ad0290d0a6e23b0c091735600255dc6cbe7/osm_bot_abstraction_layer-0.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f8e27ef5d0b315698070e981fe8c639f",
                    "sha256": "70f9aa2d6c429125ba61b77007bb14254485b6d402dcef875b1348ac22c7ac70"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f8e27ef5d0b315698070e981fe8c639f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7825,
                "upload_time": "2018-10-16T21:56:22",
                "url": "https://files.pythonhosted.org/packages/01/08/22699dedcf8c9c41d9025001744572e3e72729e0917431d890ab7680a035/osm_bot_abstraction_layer-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "332e2f0e2cc3bc3107d4ba04abc0572e",
                    "sha256": "3b9b62a94da430e7b4e0a6c62db22566cbfa3d6a7b995de5e278c104d59db70f"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "332e2f0e2cc3bc3107d4ba04abc0572e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9889,
                "upload_time": "2018-10-19T13:39:51",
                "url": "https://files.pythonhosted.org/packages/ad/cb/18a9b9ac1aae9908e715a2b5ae2fdc719dcf393c2a6fb6dd4633f9ac1694/osm_bot_abstraction_layer-0.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ad0a689b3b7abf6a476d52bc217471ba",
                    "sha256": "a0f5f2a6f7fd3ee734e2a429f4df08277f0fb641c2175468c1c22612a0e4c567"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "ad0a689b3b7abf6a476d52bc217471ba",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7944,
                "upload_time": "2018-10-19T13:39:53",
                "url": "https://files.pythonhosted.org/packages/dc/78/692115d146ff3b6a29b17b6a541e1f34e22e0b05908761dca0f269cc5361/osm_bot_abstraction_layer-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bedc8b067c9197380ab290650c855da0",
                    "sha256": "c2ca30760e46d78420a879451a6df7e7769b8668908f751e8b21ca42c241badd"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "bedc8b067c9197380ab290650c855da0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10170,
                "upload_time": "2018-10-19T15:08:56",
                "url": "https://files.pythonhosted.org/packages/70/e1/32c511fadd0b27ae0b1a7c5e74a1c2c9781a96ba788cb8488d89f1df3334/osm_bot_abstraction_layer-0.0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f20db679163870836ebdd403d5a68dc0",
                    "sha256": "38160728f730e4c0cb4072f3f09481a4706504f3d544f2b6a53648a882f7b776"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "f20db679163870836ebdd403d5a68dc0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8201,
                "upload_time": "2018-10-19T15:08:57",
                "url": "https://files.pythonhosted.org/packages/08/e9/f91d08c06a78b7c846313d49cf7815ee013798cbf68a7e21944080d40fb1/osm_bot_abstraction_layer-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "30db9e113b75dbf78d72410034808f67",
                    "sha256": "9b24367582e194afae7abbe7d003fd5fe3b7d83c769d62ae5ebab15166601d7e"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "30db9e113b75dbf78d72410034808f67",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12102,
                "upload_time": "2018-11-18T19:08:43",
                "url": "https://files.pythonhosted.org/packages/23/d4/f8cbab12bf5c23359635b43935d39d52e588e845d642a8ae0507cfdafdc9/osm_bot_abstraction_layer-0.0.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c5c82569e1e8d085f701c99e020a082",
                    "sha256": "7d2d1c0793fb755aba0e4e1f83e0c3cce796316a2fd2235b5dcc4833cbd2a50c"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "6c5c82569e1e8d085f701c99e020a082",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10445,
                "upload_time": "2018-11-18T19:08:45",
                "url": "https://files.pythonhosted.org/packages/b7/8b/4caff01773d580f57cdead3962508255b60d30f5b9a29f57058f77a0bc88/osm_bot_abstraction_layer-0.0.4.tar.gz"
            }
        ],
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b899738151679d4afda52fdda0569743",
                    "sha256": "9b8e1371f2c9f55d9450bdbc168bb2c2a43c8df2f39b2b381f7530b21735ef24"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.5-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b899738151679d4afda52fdda0569743",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 26100,
                "upload_time": "2019-05-28T09:29:16",
                "url": "https://files.pythonhosted.org/packages/d9/8c/bb58470a7f5a9455b3efbb32ab12379981d89ac43ead5c1e8d93bd0b69b3/osm_bot_abstraction_layer-0.0.5-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8143bad3ac72e87e89ad617e4426b128",
                    "sha256": "6f7d2b4e18d8cdce224f5874c9d00d24f59dbb2f5155413d2c7b76a28b662132"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "8143bad3ac72e87e89ad617e4426b128",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11669,
                "upload_time": "2019-05-28T09:29:18",
                "url": "https://files.pythonhosted.org/packages/12/23/3d6b476ede08cea781730f5d2cc2a485714b7c224f71b79a9c3891c0798f/osm_bot_abstraction_layer-0.0.5.tar.gz"
            }
        ],
        "0.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c9d1f6281ac82c7248897850a037b3a",
                    "sha256": "8166a36c6aae71958858364248a7747eeeb3e60d1b81ea142554902df57b1d02"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.6-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6c9d1f6281ac82c7248897850a037b3a",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 26146,
                "upload_time": "2019-06-01T12:41:35",
                "url": "https://files.pythonhosted.org/packages/a0/ea/18af258e2a67b75286d3372ee5487dc535736dcf09d828fe472bb4692a22/osm_bot_abstraction_layer-0.0.6-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1698037bc3c0a3b7892017a0fa8140d2",
                    "sha256": "73473d275ad83880011628ce8db0febfa934eb803d6bb6db0b058faffa1c1701"
                },
                "downloads": -1,
                "filename": "osm_bot_abstraction_layer-0.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "1698037bc3c0a3b7892017a0fa8140d2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11762,
                "upload_time": "2019-06-01T12:41:36",
                "url": "https://files.pythonhosted.org/packages/ba/7d/9d006913b86f386f20599c18f73f073669adc86e37b191f4037062583a4a/osm_bot_abstraction_layer-0.0.6.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6c9d1f6281ac82c7248897850a037b3a",
                "sha256": "8166a36c6aae71958858364248a7747eeeb3e60d1b81ea142554902df57b1d02"
            },
            "downloads": -1,
            "filename": "osm_bot_abstraction_layer-0.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6c9d1f6281ac82c7248897850a037b3a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 26146,
            "upload_time": "2019-06-01T12:41:35",
            "url": "https://files.pythonhosted.org/packages/a0/ea/18af258e2a67b75286d3372ee5487dc535736dcf09d828fe472bb4692a22/osm_bot_abstraction_layer-0.0.6-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "1698037bc3c0a3b7892017a0fa8140d2",
                "sha256": "73473d275ad83880011628ce8db0febfa934eb803d6bb6db0b058faffa1c1701"
            },
            "downloads": -1,
            "filename": "osm_bot_abstraction_layer-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "1698037bc3c0a3b7892017a0fa8140d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11762,
            "upload_time": "2019-06-01T12:41:36",
            "url": "https://files.pythonhosted.org/packages/ba/7d/9d006913b86f386f20599c18f73f073669adc86e37b191f4037062583a4a/osm_bot_abstraction_layer-0.0.6.tar.gz"
        }
    ]
}