predictionio-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From don...@apache.org
Subject [3/6] predictionio-sdk-php git commit: Doc updates
Date Mon, 19 Mar 2018 00:26:25 GMT
Doc updates


Project: http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/repo
Commit: http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/commit/0faa9bc1
Tree: http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/tree/0faa9bc1
Diff: http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/diff/0faa9bc1

Branch: refs/heads/master
Commit: 0faa9bc10cfc3a4eff5fc0958a23caf83e850d75
Parents: 73075a5
Author: Donald Szeto <donald@apache.org>
Authored: Wed Oct 25 22:33:59 2017 -0700
Committer: Donald Szeto <donald@apache.org>
Committed: Wed Oct 25 22:33:59 2017 -0700

----------------------------------------------------------------------
 CREDITS       |   3 +-
 LICENSE       | 209 ++++++++++++++++++++++++++++++++++++++++++++++++++---
 NOTICE        |   9 +++
 README.md     |  85 +++++++++-------------
 composer.json |  11 ++-
 5 files changed, 248 insertions(+), 69 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/blob/0faa9bc1/CREDITS
----------------------------------------------------------------------
diff --git a/CREDITS b/CREDITS
index f72c874..5ef150b 100644
--- a/CREDITS
+++ b/CREDITS
@@ -1,4 +1,5 @@
-PredictionIO PHP SDK is made possible by the PredictionIO PHP SDK open source project and
other open source software.
+Apache PredictionIO PHP SDK is made possible by the Apache PredictionIO
+PHP SDK open source project and other open source software.
 
 
 Guzzle

http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/blob/0faa9bc1/LICENSE
----------------------------------------------------------------------
diff --git a/LICENSE b/LICENSE
index 11c8530..d645695 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,13 +1,202 @@
-Copyright 2013 TappingStone Inc.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/blob/0faa9bc1/NOTICE
----------------------------------------------------------------------
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..a0210eb
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,9 @@
+Apache PredictionIO
+Copyright 2017 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+This product depends on third party software that falls under a variety of licenses.
+All dependencies with licenses other than Apache are specified in the LICENSE file.
+Please see LICENSE for additional copyright and licensing information.

http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/blob/0faa9bc1/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c6d99c1..8f9d38b 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,18 @@
-PredictionIO PHP SDK
-====================
+# Apache PredictionIO PHP SDK
 
-[![Build Status](https://travis-ci.org/PredictionIO/PredictionIO-PHP-SDK.png?branch=develop)](https://travis-ci.org/PredictionIO/PredictionIO-PHP-SDK)
-[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/PredictionIO/PredictionIO-PHP-SDK/badges/quality-score.png?s=bba570e3add382f4f56fcba65ec0b4f0b8622091)](https://scrutinizer-ci.com/g/PredictionIO/PredictionIO-PHP-SDK/)
-[![Code Coverage](https://scrutinizer-ci.com/g/PredictionIO/PredictionIO-PHP-SDK/badges/coverage.png?s=db1de9fde081fedd79346b4aba562ab56853ed45)](https://scrutinizer-ci.com/g/PredictionIO/PredictionIO-PHP-SDK/)
 
-Prerequisites
-=============
+[![Build Status](https://travis-ci.org/apache/incubator-predictionio-sdk-php.svg?branch=develop)](https://travis-ci.org/apache/incubator-predictionio-sdk-php)
+
+## Prerequisites
 
 * PHP 5.4+ (http://php.net/)
 * PHP: cURL (http://php.net/manual/en/book.curl.php)
 * Phing (http://www.phing.info/)
 * ApiGen (http://apigen.org/)
 
-Note: This SDK only supports Prediction IO version 0.8.2 or higher.
-
-Support
-=======
-
-
-Forum
------
-
-https://groups.google.com/group/predictionio-user
-
-
-Issue Tracker
--------------
+Note: This SDK only supports Apache PredictionIO version 0.8.2 or higher.
 
-https://predictionio.atlassian.net
-
-If you are unsure whether a behavior is an issue, bringing it up in the forum is highly encouraged.
-
-
-Getting Started
-===============
-
-
-By Composer
------------
+## Getting Started
 
 The easiest way to install PredictionIO PHP client is to use [Composer](http://getcomposer.org/).
 
@@ -62,22 +36,12 @@ The easiest way to install PredictionIO PHP client is to use [Composer](http://g
 
         require_once("vendor/autoload.php");
 
-
-Supported Commands
-==================
-
-For a list of supported commands, please refer to the
-[API documentation](http://docs.prediction.io/php/api/).
-
-
-Usage
-=====
+## Usage
 
 This package is a web service client based on Guzzle.
 A few quick examples are shown below.
 
-Instantiate PredictionIO API Event Client
------------------------------------
+### Instantiate PredictionIO API Event Client
 
 ```PHP
 use predictionio\EventClient;
@@ -85,8 +49,7 @@ $accessKey = 'j4jIdbq59JsF2f4CXwwkIiVHNFnyNvWXqMqXxcIbQDqFRz5K0fe9e3QfqjKwvW3O';
 $client = new EventClient($accessKey, 'http://localhost:7070');
 ```
 
-Set a User Record from Your App
--------------------------------
+### Set a User Record from Your App
 
 ```PHP
 // assume you have a user with user ID 5
@@ -94,8 +57,7 @@ $response = $client->setUser(5);
 ```
 
 
-Set an Item Record from Your App
----------------------------------
+### Set an Item Record from Your App
 
 ```PHP
 // assume you have a book with ID 'bookId1' and we assign 1 as the type ID for book
@@ -103,8 +65,7 @@ $response = $client->setItem('bookId1', array('itypes' => 1));
 ```
 
 
-Import a User Action (View) form Your App
------------------------------------------
+### Import a User Action (View) form Your App
 
 ```PHP
 // assume this user has viewed this book item
@@ -112,8 +73,7 @@ $client->recordUserActionOnItem('view', 5, 'bookId1');
 ```
 
 
-Retrieving Prediction Result
-----------------------------
+### Retrieving Prediction Result
 
 ```PHP
 // assume you have created an itemrank engine on localhost:8000
@@ -124,3 +84,24 @@ $response = $engineClient->sendQuery(array('uid'=>7, 'iids'=>array(1,2,3,4,5)));
 
 print_r($response);
 ```
+
+## Bugs and Feature Requests
+
+Use [Apache JIRA](https://issues.apache.org/jira/browse/PIO) to report bugs or request new
features.
+
+## Community
+
+Keep track of development and community news.
+
+*   Subscribe to the user mailing list <mailto:user-subscribe@predictionio.apache.org>
+    and the dev mailing list <mailto:dev-subscribe@predictionio.apache.org>
+*   Follow [@PredictionIO](https://twitter.com/PredictionIO) on Twitter.
+
+## Contributing
+
+Read the [Contribute Code](http://predictionio.apache.org/community/contribute-code/) page.
+
+## License
+
+Apache PredictionIO is under [Apache 2
+license](http://www.apache.org/licenses/LICENSE-2.0.html).

http://git-wip-us.apache.org/repos/asf/predictionio-sdk-php/blob/0faa9bc1/composer.json
----------------------------------------------------------------------
diff --git a/composer.json b/composer.json
index 395a59f..570dac5 100644
--- a/composer.json
+++ b/composer.json
@@ -1,23 +1,22 @@
 {
     "name": "predictionio/predictionio",
     "type": "library",
-    "description": "PredictionIO API PHP Client",
+    "description": "Apache PredictionIO API PHP Client",
     "keywords": [
         "predictionio",
-        "tappingstone",
         "rest",
         "restful",
         "web service",
         "prediction",
         "recommendation"
     ],
-    "homepage": "http://prediction.io",
+    "homepage": "http://predictionio.apache.org",
     "license": "Apache-2.0",
     "authors": [
         {
-            "name": "The PredictionIO Team",
-            "email": "help@prediction.io",
-            "homepage": "http://prediction.io"
+            "name": "Apache PredictionIO",
+            "email": "user@predictionio.apache.org",
+            "homepage": "http://predictionio.apache.org"
         }
     ],
     "require": {


Mime
View raw message