@ohos-ports/node-postal 1.3.0-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 openvenues
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,112 @@
+node-postal
+-----------
+
+[![Build Status](https://travis-ci.org/openvenues/node-postal.svg?branch=master)](https://travis-ci.org/openvenues/node-postal) [![npm](https://img.shields.io/npm/v/node-postal.svg)](https://www.npmjs.com/package/node-postal)
+
+These are the NodeJS bindings to [libpostal](https://github.com/openvenues/libpostal), a fast, multilingual NLP library for parsing/normalizing physical addresses. libpostal is written in C because virtually every other language can bind to C.
+
+Usage
+-----
+
+```node
+var postal = require('node-postal');
+
+// Expansion API
+postal.expand.expand_address('V XX Settembre, 20');
+
+// Parser API
+postal.parser.parse_address('Barboncino (first unionized pizza place in NYC), 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238');
+```
+
+Installation
+------------
+
+Before using the Node bindings, you must install the libpostal C library. Make sure you have the following prerequisites:
+
+**On Ubuntu/Debian**
+```
+sudo apt-get install curl autoconf automake libtool pkg-config
+```
+
+**On CentOS/RHEL**
+```
+sudo yum install curl autoconf automake libtool pkgconfig
+```
+
+**On Mac OSX**
+```
+brew install curl autoconf automake libtool pkg-config
+```
+
+**Installing libpostal**
+
+```
+git clone https://github.com/openvenues/libpostal
+cd libpostal
+./bootstrap.sh
+./configure --datadir=[...some dir with a few GB of space...]
+make
+sudo make install
+
+# On Linux it's probably a good idea to run
+sudo ldconfig
+```
+**Install node-gyp**
+
+Then install node-gyp system-wide:
+
+```
+sudo npm install -g node-gyp
+```
+
+**Installing node-gyp on Linux (Ubuntu)**
+
+First make sure you have:
+
+1. gcc, g++ and make (```sudo apt-get install build-essential``` on Ubuntu)
+2. NodeJS with all the development headers (if using a package manager like apt-get, follow the instructions here: https://nodejs.org/en/download/package-manager/)
+3. python 2.7
+
+
+**Installing the Node bindings**
+
+```
+npm install node-postal
+```
+
+Compatibility
+-------------
+
+node-postal is tested on most major versions of Node (0.10+) in continuous integration. The C++ bindings are written using [Nan](https://github.com/nodejs/nan), which abstracts the API changes across various versions of V8, so the latest versions of Node will likely work.
+
+If you're having trouble compiling, post a Github issue with your OS and Node versions along with the output of npm install / node-gyp rebuild.
+
+Tests
+-----
+
+To run the unit tests:
+
+```
+npm test
+```
+
+Troubleshooting
+---------------
+**Installing [libpostal](https://github.com/openvenues/libpostal):**
+node-postal is a thin wrapper around libpostal, which is written in C. Installing node-postal with npm will not install libpostal as a dependency. The install steps described above will install it in standard locations for your OS. For OS X and Linux, that's `/usr/local/include` and `/usr/local/lib`. node-postal will look in these locations for the C libraries. If you have problems installing node-postal, check there for recently installed libpostal libraries.
+
+**Downloading Large Files**
+The ```make``` process downloads ~750MB of data, ~2GB unzipped (note: these are production-quality machine learning models trained on over a billion addresses, that's how much disk/memory it takes). Make sure the --datadir argument to ```configure```, which requires an absolute path, has enough room to accommodate the models. If you get errors after downloading, e.g.:
+```
+make[3]: *** [all-local] Error 1
+make[2]: *** [all-recursive] Error 1
+make[1]: *** [all-recursive] Error 1
+make: *** [all] Error 2
+```
+
+there may be problems with subsequent install steps. Occasionally something will go wrong and it will give up downloading. Once downloading is complete, the make script will unpack the langauge_classifier.tar.gz.X files. If you see these files, your download may have stopped. Try running the make script again.
+
+Special Thanks
+--------------
+
+Lucas Hrabovsky (https://github.com/imlucas) for information and examples of repos using Nan, node-gyp, etc.

package/index.js

@@ -0,0 +1,5 @@
+
+module.exports = {
+    expand: require('bindings')('expand'),
+    parser: require('bindings')('parser')
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@ohos-ports/node-postal",
+  "version": "1.3.0-beta.0",
+  "author": "Al Barrentine (@thatdatabaseguy)",
+  "description": "International address parsing/normalization at C speed",
+  "main": "index.js",
+  "license": "MIT",
+  "keywords": [
+    "libpostal",
+    "addresses",
+    "address parsing",
+    "i18n",
+    "geo",
+    "deduping",
+    "machine learning",
+    "natural language processing",
+    "nlp",
+    "c"
+  ],
+  "homepage": "https://github.com/openvenues/node-postal",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/node-postal/1.3.0"
+  },
+  "dependencies": {
+    "bindings": "^1.5.0",
+    "nan": "^2.22.0"
+  },
+  "devDependencies": {
+    "mocha": "^7.1.1",
+    "simplesets": "^1.2.0"
+  },
+  "scripts": {
+    "test": "mocha ./test"
+  },
+  "files": [
+    "index.js",
+    "build/Release/*.node"
+  ]
+}