| Name | atlus JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Translate raw address strings into the OSM tagging scheme. |
| upload_time | 2024-08-02 00:14:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
address
geocoding
mapping
openstreetmap
osm
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Atlus
This Python project translates raw address strings into the OpenStreetMap (OSM) tagging scheme. The package only supports US (and to some extent Canadian) addresses. You can try out the package without installing it at [the Atlus website](https://atlus.dev).
> [!NOTE]
> Use of this package does not absolve you from following OSM's [import guidelines](https://wiki.openstreetmap.org/wiki/Import/Guidelines).
## Table of Contents
- [Features](#features)
- [Usage](#usage)
- [Docs](#docs)
- [License](#license)
## Features
- Expand common street and name abbreviations.
- Parse address parts correctly and reliably.
- Get rid of address junk that is not needed for OpenStreetMap tagging.
- Parse US and Canadian phone numbers into the standard format.
## Usage
This package is meant to work with GeoJSON files containing raw address data, including those produced by the [All the Places](https://alltheplaces.xyz) project or [Overture maps](https://wiki.openstreetmap.org/wiki/Overture).
```console
pip install atlus
```
```python
>>> import atlus
>>> atlus.abbrs("St. Francis")
"Saint Francis"
>>> atlus.get_address("789 Oak Dr, Smallville California, 98765")
{"addr:housenumber": "789", "addr:street": "Oak Drive", "addr:city": "Smallville", "addr:state": "CA", "addr:postcode": "98765"}
>>> atlus.get_phone("(202) 900-9019")
"+1 202-900-9019"
```
## Docs
The documentation for our package is available online at our [documentation page](https://whubsch.github.io/atlus/index.html). We would greatly appreciate your contributions to help improve the auto-generated docs; please submit any updates or corrections via pull requests.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for details.
## See also
- [OpenStreetMap](https://www.openstreetmap.org/)
- [Atlus](https://wiki.openstreetmap.org/wiki/atlus)
- [All the Places](https://wiki.openstreetmap.org/wiki/All_the_Places)
Raw data
{
"_id": null,
"home_page": null,
"name": "atlus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "address, geocoding, mapping, openstreetmap, osm",
"author": null,
"author_email": "Will <wahubsch@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7d/69/d609aa0cca794cf83f388fb020c91ad0479ee5327f7ce4eec37e1c377944/atlus-0.2.3.tar.gz",
"platform": null,
"description": "# Atlus\n\n\n\n\n\n\nThis Python project translates raw address strings into the OpenStreetMap (OSM) tagging scheme. The package only supports US (and to some extent Canadian) addresses. You can try out the package without installing it at [the Atlus website](https://atlus.dev).\n\n> [!NOTE]\n> Use of this package does not absolve you from following OSM's [import guidelines](https://wiki.openstreetmap.org/wiki/Import/Guidelines).\n\n## Table of Contents\n\n- [Features](#features)\n- [Usage](#usage)\n- [Docs](#docs)\n- [License](#license)\n\n## Features\n\n- Expand common street and name abbreviations.\n- Parse address parts correctly and reliably.\n- Get rid of address junk that is not needed for OpenStreetMap tagging.\n- Parse US and Canadian phone numbers into the standard format.\n\n## Usage\n\nThis package is meant to work with GeoJSON files containing raw address data, including those produced by the [All the Places](https://alltheplaces.xyz) project or [Overture maps](https://wiki.openstreetmap.org/wiki/Overture).\n\n```console\npip install atlus\n```\n\n```python\n>>> import atlus\n>>> atlus.abbrs(\"St. Francis\")\n\"Saint Francis\"\n>>> atlus.get_address(\"789 Oak Dr, Smallville California, 98765\")\n{\"addr:housenumber\": \"789\", \"addr:street\": \"Oak Drive\", \"addr:city\": \"Smallville\", \"addr:state\": \"CA\", \"addr:postcode\": \"98765\"}\n>>> atlus.get_phone(\"(202) 900-9019\")\n\"+1 202-900-9019\"\n```\n\n## Docs\n\nThe documentation for our package is available online at our [documentation page](https://whubsch.github.io/atlus/index.html). We would greatly appreciate your contributions to help improve the auto-generated docs; please submit any updates or corrections via pull requests.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for details.\n\n## See also\n\n- [OpenStreetMap](https://www.openstreetmap.org/)\n- [Atlus](https://wiki.openstreetmap.org/wiki/atlus)\n- [All the Places](https://wiki.openstreetmap.org/wiki/All_the_Places)\n",
"bugtrack_url": null,
"license": null,
"summary": "Translate raw address strings into the OSM tagging scheme.",
"version": "0.2.3",
"project_urls": {
"Documentation": "https://whubsch.github.io/atlus/index.html",
"Issues": "https://github.com/whubsch/atlus/issues",
"Source": "https://github.com/whubsch/atlus"
},
"split_keywords": [
"address",
" geocoding",
" mapping",
" openstreetmap",
" osm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc72320c15000a78389674c82a87588239e1205955e740576388c560c9ec812c",
"md5": "1f5aa7dc36629799772e88eb4f60068c",
"sha256": "4c96816213fba9cb37481b307e347346b3c619b435d5ec0bf1f3c56398d4f17b"
},
"downloads": -1,
"filename": "atlus-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f5aa7dc36629799772e88eb4f60068c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11923,
"upload_time": "2024-08-02T00:14:14",
"upload_time_iso_8601": "2024-08-02T00:14:14.038300Z",
"url": "https://files.pythonhosted.org/packages/bc/72/320c15000a78389674c82a87588239e1205955e740576388c560c9ec812c/atlus-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d69d609aa0cca794cf83f388fb020c91ad0479ee5327f7ce4eec37e1c377944",
"md5": "288d5b5c72184f76f810dc4d52b79f07",
"sha256": "5447f274aa23c0517c9bf1d808fc6466deaea36c361d8d78388c05a8a799743f"
},
"downloads": -1,
"filename": "atlus-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "288d5b5c72184f76f810dc4d52b79f07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 189181,
"upload_time": "2024-08-02T00:14:15",
"upload_time_iso_8601": "2024-08-02T00:14:15.918684Z",
"url": "https://files.pythonhosted.org/packages/7d/69/d609aa0cca794cf83f388fb020c91ad0479ee5327f7ce4eec37e1c377944/atlus-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 00:14:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whubsch",
"github_project": "atlus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "atlus"
}
