@planet/client requires Node >= 0.12. Install the
npm (which comes with Node).
npm install @planet/client
@planet/client package provides a library for use in your application and a
planet executable for command line use. See details on both below.
Using the Library
It is also possible to load a standalone bundle of the library in a script tag. Without a module loader, this will create a global
This will redirect to the most recent release. To avoid the redirect, you can include a specific version number (e.g. https://unpkg.com/@email@example.com/dist/planet.js).
See the API docs for detail on using the package.
To get set up, clone the repository and install the development dependencies:
git clone firstname.lastname@example.org:planetlabs/client.git cd client npm install
Running the tests
The tests are run in a browser and in Node. You can run the linter and all tests once with the following:
To start a file watcher that runs the linter and tests with any file changes:
npm start task running, you can attach any number of browsers to the test server. Every time you attach a new browser, tests run in all browsers. To debug any failing test, visit the test runner debug page and open your development console.
Building the docs
The project docs are generated from templates in the
doc directory. The API docs are generated based on annotations in comments throughout the
api modules. You can build the docs with the following task:
npm run doc
You can view the doc output in the
Note - Building the docs requires Node >= 8.0.
Publishing a release
Releases are published from the master branch. To cut a new minor release, do this:
npm version minor && git push --tags origin master && npm publish
postpublish script will update the hosted version of the docs.
Note - Publishing a release requires Node >= 8.0.
© Planet Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
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.