Skip to content

Commit

Permalink
Transfer perspective to finos
Browse files Browse the repository at this point in the history
  • Loading branch information
texodus committed Apr 30, 2019
1 parent c422f4a commit e6ccf1d
Show file tree
Hide file tree
Showing 88 changed files with 327 additions and 250 deletions.
3 changes: 3 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct for {project name}

Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct).
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected 🤔.

---

## Bug Report

### Steps to Reproduce:
1. ...step 1 description...
2. ...step 2 description...
3. ...step 3 description...

### Expected Result:
...description of what you expected to see...

### Actual Result:
...what actually happened, including full exceptions (please include the entire stack trace, including "caused by" entries), log entries, screen shots etc. where appropriate...

### Environment:
...version and build of the project, OS and runtime versions, virtualised environment (if any), etc. ...

### Additional Context:
...add any other context about the problem here. If applicable, add screenshots to help explain...
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: 🚀 Feature Request
about: I have a suggestion (and may want to implement it 🙂)!

---

## Feature Request

### Description of Problem:
...what *problem* are you trying to solve that the project doesn't currently solve?

...please resist the temptation to describe your request in terms of a solution. Job Story form ("When [triggering condition], I want to [motivation/goal], so I can [outcome].") can help ensure you're expressing a problem statement.

### Potential Solutions:
...clearly and concisely describe what you want to happen. Add any considered drawbacks.

... if you've considered alternatives, clearly and concisely describe those too.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/Support_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: 🤗 Support Question
about: If you have a question about configuration, usage, etc. 💬

---

## Support Question

...ask your question here.

...be sure to search existing issues since someone might have already asked something similar.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Thank you for your interest in contributing to Perspective!

Perspective is built on open source and we invite you to contribute enhancements. Upon review you will be required to complete the [Contributor License Agreement (CLA)](https://github.com/jpmorganchase/cla) before we are able to merge.
Perspective is built on open source and we invite you to contribute enhancements. Upon review you will be required to complete the [Contributor License Agreement (CLA)](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements#ContributionComplianceRequirements-ContributorLicenseAgreement) before we are able to merge.

If you have any questions about the contribution process, please feel free to chat with us on [gitter](https://gitter.im/jpmorganchase/perspective), or send an email to [[email protected]](mailto:quorum_info@jpmorgan.com).
If you have any questions about the contribution process, please feel free to chat with us on [gitter](https://gitter.im/finos/perspective), or open an issue on [github](https://github.com/finos/perspective/issues/new)

## Guidelines

Expand All @@ -19,8 +19,8 @@ coding guidelines:
* Please do not submit incomplete PRs or partially implemented features. Feature additions should be implemented completely, including Javascript API and `<perspective-viewer>` UX. If your PR is a build, documentation, test change, or an API change that is not applicable to the UX, please explain this in the comments.
* Please do not submit PRs disabled by feature or build flag - experimental features should be kept on a branch until they are ready to be merged.
* Feature additions, make sure you have added complete JSDoc to any new APIs, as well as additions to the [Usage Guide]() if applicable.
* All PRs should be accompanied by tests asserting their behavior in any packages they modify. C++ and Javascript changes to `@jpmorganchase/perspective` should add Node.js tests, and additional changes should add Puppeteer tests.
* If your PR modifies the C++ or JS `@jpmorganchase/perspective` code in a way which may affect performance, be sure to update the benchmark suite as per the [Developer Documentation]().
* All PRs should be accompanied by tests asserting their behavior in any packages they modify. C++ and Javascript changes to `@finos/perspective` should add Node.js tests, and additional changes should add Puppeteer tests.
* If your PR modifies the C++ or JS `@finos/perspective` code in a way which may affect performance, be sure to update the benchmark suite as per the [Developer Documentation]().
* Do not commit with `--no-verify` or otherwise bypass commit hooks, and please respect the formatting and linting guidelines they enforce.
* Do not `merge master` upstream changes into your PR. If your change has conflicts with the `master` branch, please pull master into your fork's master, then rebase.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2019 JP Morgan Chase

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# [![Perspective](https://jpmorganchase.github.io/perspective/img/title.png)](https://jpmorganchase.github.io/perspective/)
# [![Perspective](https://perspective.finos.org/img/title.png)](https://perspective.finos.org/)

[![Build Status](https://travis-ci.org/jpmorganchase/perspective.svg?branch=master)](https://travis-ci.org/jpmorganchase/perspective)
[![Appveyor](https://ci.appveyor.com/api/projects/status/github/jpmorganchase/perspective?svg=true)](https://ci.appveyor.com/project/neilslinger/perspective)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/jpmorganchase/perspective)
[![npm](https://img.shields.io/npm/v/@jpmorganchase/perspective.svg?style=flat-square)](https://www.npmjs.com/package/@jpmorganchase/perspective)
[![Build Status](https://travis-ci.org/finos/perspective.svg?branch=master)](https://travis-ci.org/finos/perspective)
[![Appveyor](https://ci.appveyor.com/api/projects/status/github/finos/perspective?svg=true)](https://ci.appveyor.com/project/neilslinger/perspective)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/finos/perspective)
[![npm](https://img.shields.io/npm/v/@finos/perspective.svg?style=flat-square)](https://www.npmjs.com/package/@finos/perspective)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![FINOS - Operating](https://cdn.rawgit.com/finos/contrib-toolbox/master/images/badge-operating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Operating)


A streaming data visualization engine for Javascript, Perspective makes it
simple to build real-time & user configurable analytics entirely in the browser.

<img src="https://jpmorganchase.github.io/perspective/img/demo.gif">
<img src="https://perspective.finos.org/img/demo.gif">

## Features

Expand All @@ -27,7 +27,7 @@ simple to build real-time & user configurable analytics entirely in the browser.
[d3fc](https://d3fc.io/), [Hypergrid](https://github.com/fin-hypergrid/core) and
[HighCharts](https://github.com/highcharts/highcharts).

- Integration with [Jupyterlab](https://github.com/jpmorganchase/perspective/tree/master/packages/perspective-jupyterlab).
- Integration with [Jupyterlab](https://github.com/finos/perspective/tree/master/packages/perspective-jupyterlab).

- Runtimes for the Browser and Node.js.

Expand All @@ -46,9 +46,9 @@ simple to build real-time & user configurable analytics entirely in the browser.

## Documentation

* [Project Site](https://jpmorganchase.github.io/perspective/)
* [Installation](https://jpmorganchase.github.io/perspective/docs/installation.html)
* [User's Guide](https://jpmorganchase.github.io/perspective/docs/usage.html)
* [Developer's Guide](https://jpmorganchase.github.io/perspective/docs/development.html)
* [Perspective API](https://github.com/jpmorganchase/perspective/blob/master/packages/perspective/README.md)
* [Perspective Viewer API](https://github.com/jpmorganchase/perspective/blob/master/packages/perspective-viewer/README.md)
* [Project Site](https://perspective.finos.org/)
* [Installation](https://perspective.finos.org/docs/installation.html)
* [User's Guide](https://perspective.finos.org/docs/usage.html)
* [Developer's Guide](https://perspective.finos.org/docs/development.html)
* [Perspective API](https://github.com/finos/perspective/blob/master/packages/perspective/README.md)
* [Perspective Viewer API](https://github.com/finos/perspective/blob/master/packages/perspective-viewer/README.md)
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Perspective Documentation Site

This is the source for the [Perspective documentaiton github-pages site](https://jpmorganchase.github.io/perspective/) -
This is the source for the [Perspective documentaiton github-pages site](https://perspective.finos.org/) -
what you're looking for is probably there. Links to the source documenation
from which the site is rendered:

* [Installation](https://github.com/jpmorganchase/perspective/blob/master/docs/md/installation.md)
* [User's Guide](https://github.com/jpmorganchase/perspective/blob/master/docs/md/usage.md)
* [Developer's Guide](https://github.com/jpmorganchase/perspective/blob/master/docs/md/development.md)
* [Perspective API](https://github.com/jpmorganchase/perspective/blob/master/packages/perspective/README.md)
* [Perspective Viewer API](https://github.com/jpmorganchase/perspective/blob/master/packages/perspective-viewer/README.md)
* [Installation](https://github.com/finos/perspective/blob/master/docs/md/installation.md)
* [User's Guide](https://github.com/finos/perspective/blob/master/docs/md/usage.md)
* [Developer's Guide](https://github.com/finos/perspective/blob/master/docs/md/development.md)
* [Perspective API](https://github.com/finos/perspective/blob/master/packages/perspective/README.md)
* [Perspective Viewer API](https://github.com/finos/perspective/blob/master/packages/perspective-viewer/README.md)
2 changes: 1 addition & 1 deletion docs/core/Footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class Footer extends React.Component {
<div>
<h5>More</h5>
<a href={this.props.config.baseUrl + "blog"}>Blog</a>
<a href="https://github.com/jpmorganchase/perspective/">GitHub</a>
<a href="https://github.com/finos/perspective/">GitHub</a>
<a
className="github-button"
href={this.props.config.repoUrl}
Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ Perspective
.. rst/python
.. rst/cpp
.. |build-status| image:: https://travis-ci.org/jpmorganchase/perspective.svg?branch=master
.. |build-status| image:: https://travis-ci.org/finos/perspective.svg?branch=master
:alt: Build Status
:scale: 100%
:target: https://travis-ci.org/jpmorganchase/perspective
:target: https://travis-ci.org/finos/perspective

.. |issues| image:: https://img.shields.io/github/issues/jpmorganchase/perspective.svg
.. |issues| image:: https://img.shields.io/github/issues/finos/perspective.svg
:alt: Issues
:scale: 100%
:target: https://img.shields.io/github/issues/jpmorganchase/perspective.svg
:target: https://img.shields.io/github/issues/finos/perspective.svg
6 changes: 3 additions & 3 deletions docs/md/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ possible, but some things might not work the way you're used to!

Perspective is organized as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md),
and uses [lerna](https://lernajs.io/) to manage dependencies. The
`@jpmorganchase/perspective` modules has an additional, unmanaged dependency
`@finos/perspective` modules has an additional, unmanaged dependency
however; the [Emscripten](https://github.com/kripken/emscripten) compiler, which
is used to compile the core C++ engine to WebAssembly, and must be installed
independently.
Expand Down Expand Up @@ -97,7 +97,7 @@ Whichever method you choose, the build script respects a few environment flags:
- `PSP_DEBUG` will run a debug build of the C++ source.
- `PSP_NO_MINIFY` will skip Javascript minification.
- `PSP_CPU_COUNT` will set the concurrency limit for the build.
- `PACKAGE` will restrict the build to only specific `@jpmorganchase/` packages.
- `PACKAGE` will restrict the build to only specific `@finos/` packages.

## Testing

Expand All @@ -115,7 +115,7 @@ yarn test -t 'button test (A|B)'
```

The test suite is composed of two sections: a Node.js test which asserts
behavior of the `@jpmorganchase/perspective` library, and a suite of
behavior of the `@finos/perspective` library, and a suite of
[Puppeteer](https://developers.google.com/web/tools/puppeteer/) tests which
assert the behavior of the rest of the UI facing packages. For the latter,
you'll need Docker installed, as these tests use a Puppeteer and Chrome build
Expand Down
32 changes: 16 additions & 16 deletions docs/md/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ have access to the `.worker.*.js` and `.wasm` assets in addition to the
bundled scripts themselves. These are downloaded asynchronously at runtime
after detecting whether or not WebAssembly is supported by your browser. The
assets can be found in the `build/` directory of the
`@jpmorganchase/perspective` and `@jpmorganchase/perspective-viewer` packages.
`@finos/perspective` and `@finos/perspective-viewer` packages.

When importing from NPM modules, you should use
`@jpmorganchase/perspective-webpack-plugin` to manage the `.worker.*.js` and
`@finos/perspective-webpack-plugin` to manage the `.worker.*.js` and
`.wasm` assets for you. A sample config:

```javascript
const PerspectivePlugin = require("@jpmorganchase/perspective-webpack-plugin");
const PerspectivePlugin = require("@finos/perspective-webpack-plugin");

module.exports = {
entry: "./in.js",
Expand All @@ -35,22 +35,22 @@ the contents of a package's `build/` in your application's build script, or
otherwise making sure these directories are visible to your web server, e.g.:

```javascript
cp -r node_modules/@jpmorganchase/perspective/build my_build/assets/
cp -r node_modules/@finos/perspective/build my_build/assets/
```

## From CDN

By far the easiest way to get started with Perspective in the browser, the full
library can be used directly from
[unpkg.com](https://unpkg.com/@jpmorganchase/perspective-examples/build/perspective.view.js)
[unpkg.com](https://unpkg.com/@finos/perspective-examples/build/perspective.view.js)
CDN by simply adding these scripts to your `.html`'s `<head>` section:

```html
<script src="https://unpkg.com/@jpmorganchase/perspective"></script>
<script src="https://unpkg.com/@jpmorganchase/perspective-viewer"></script>
<script src="https://unpkg.com/@jpmorganchase/perspective-viewer-hypergrid"></script>
<script src="https://unpkg.com/@jpmorganchase/perspective-viewer-d3fc"></script>
<script src="https://unpkg.com/@jpmorganchase/perspective-viewer-highcharts"></script>
<script src="https://unpkg.com/@finos/perspective"></script>
<script src="https://unpkg.com/@finos/perspective-viewer"></script>
<script src="https://unpkg.com/@finos/perspective-viewer-hypergrid"></script>
<script src="https://unpkg.com/@finos/perspective-viewer-d3fc"></script>
<script src="https://unpkg.com/@finos/perspective-viewer-highcharts"></script>
```

Ultimately, for production you'll want Perspective incorporated directly into your
Expand All @@ -63,15 +63,15 @@ For using Perspective from Node.js, or as a depedency in a `package.json` based
via NPM

```bash
yarn add @jpmorganchase/perspective-viewer
yarn add @jpmorganchase/perspective-viewer-d3fc
yarn add @jpmorganchase/perspective-viewer-hypergrid
yarn add @finos/perspective-viewer
yarn add @finos/perspective-viewer-d3fc
yarn add @finos/perspective-viewer-hypergrid
```

## From source

For hackers, contributors, and masochists, Perspective can be installed directly
from source available on [Github](https://github.com/jpmorganchase/perspective).
from source available on [Github](https://github.com/finos/perspective).
Doing so is quite a bit more complex than a standard pure Javascript NPM
package, so if you're not looking to hack on Perspective itself, you are likely
better off choosing the CDN or NPM methods above. See the
Expand All @@ -86,7 +86,7 @@ package. `perspective-python` implements mostly the same API as
`<perspective-viewer>`, and works with static `pandas.DataFrame` objects as well
as streaming incremental updates via the `update()` method (as in Javascript).

<img src="https://jpmorganchase.github.io/perspective/img/jupyterlab.png"></img>
<img src="https://perspective.finos.org/img/jupyterlab.png"></img>

You'll need to install both to utilize Perspective from Python in Jupyterlab.
Assuming you've already installed the latter 3, you can install the Perspective
Expand All @@ -96,6 +96,6 @@ plugin as below, or follow the install from source instructions from the

```bash
pip install perspective-python
jupyter labextension install @jpmorganchase/perspective-jupyterlab
jupyter labextension install @finos/perspective-jupyterlab
```

Loading

0 comments on commit e6ccf1d

Please sign in to comment.