Add CI and pypi deployment (#8)

Author: anders-kiaer

.travis.yml

@@ -0,0 +1,39 @@
+language: python
+dist: bionic
+
+addons:
+  chrome: stable
+
+services:
+  - xvfb
+
+python:
+  - "3.6"
+
+before_install:
+  - sudo apt-get -qq update
+  - pip freeze | grep -vw "pip" | xargs pip uninstall -y
+  - pip install --upgrade pip
+
+install:
+  - pip install .[dependencies]
+  - pip install .[tests]
+  - pip install dash[testing]
+  - npm install
+  - wget https://chromedriver.storage.googleapis.com/76.0.3809.12/chromedriver_linux64.zip
+  - unzip chromedriver_linux64.zip
+  - export PATH=$PATH:$PWD
+
+script:
+  - npm run test
+  - npm run build
+  - pip install .
+  - pytest
+
+deploy:
+  - provider: pypi
+    user: webviz
+    password:
+      secure: "O35ATzdM5i5dEQQksZIi5JJEmgTWU4bHQBRLZiLosLZ4oDbOF6E+QlOISymJizw2EGu02vYr0b0mIDOT21hO9T0R1snq7Gl9zQMJoZyR5FV9ZD2jFZNOODVmuCZGjUZkyblnGMQD93c9Q1Mi+iFHRaokYN3qD8Jgm8MVap1qBIJgcNLwzB6qng0K8Dj1BJRlccuAIqxa01cxBoRAgjtugXSYmrUgmO8GAiMGCQBQgnk2LWMhIgZ3c8O4rDwjNfEEg1vr34t66XuO6p17oSVBt+ncE0UjAR0PEuxVayQ1M9KCV7Awgb5MQcQMcC5I6jvdiIqzLkH8A71ORtgohd9vhy3OlnersR3sLXdRumekWy+JkD1JL2KgzJoUrlQ/asOphMJhmv6Pbg8BmJTGKWDWF12zqNX9Q9b+WN2cjmXbwBSADM9K5qsQb2Bjw+tlhDBzAQPVl89hBYodVY5yhk+soMgJqRQEDcn30t7cJUCEJEoEkQUbkTPGtZberWqKzRDFYC8cr3lwYTenzm8ARVEFOslQx8AadW2bq0Nz49osYB/AXFkF5voBf3eVthplsU5JPDiik7zTgl3Ee11Tth/NMAdxoF3dtGs4F87n6zs2e369CD8EtkaFkDaPv7htb1/6fjYGF/rbYye9CmRhJARQYcjoZnj4ekLmJVFu+k+VzN0="
+    on:
+      tags: true

README.md

@@ -1,94 +1,91 @@
-# webviz-core-components
+[![PyPI version](https://badge.fury.io/py/webviz-core-components.svg)](https://badge.fury.io/py/webviz-core-components)
+[![Build Status](https://travis-ci.org/equinor/webviz-core-components.svg?branch=master)](https://travis-ci.org/equinor/webviz-core-components)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e5f81735a1a9423eb7be3fee8e2d30ee)](https://www.codacy.com/app/anders-kiaer/webviz-core-components?utm_source=github.com&utm_medium=referral&utm_content=equinor/webviz-core-components&utm_campaign=Badge_Grade)
+[![Python 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/)
 
-webviz-core-components is a Dash component library.
+# Webviz core components
 
-Get started with:
-1. Install Dash and its dependencies: https://dash.plot.ly/installation
-2. Run `python usage.py`
-3. Visit http://localhost:8050 in your web browser
+`webviz_core_components` is a Dash component library for use in `webviz`.
+
+You can quickly get started with:
+
+1.  Run `pip install webviz-core-components`
+2.  Run `python usage.py`
+3.  Visit http://localhost:8050 in your web browser
 
 ## Contributing
 
-See [CONTRIBUTING.md](./CONTRIBUTING.md)
+This project was generated by the
+[dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate).
+It contains the minimal set of code required to create a custom Dash component.
 
 ### Install dependencies
 
 If you have selected install_dependencies during the prompt, you can skip this part.
 
 1. Install npm packages
     ```
-    $ npm install
+    npm install
     ```
 2. Create a virtual env and activate.
     ```
-    $ virtualenv venv
-    $ . venv/bin/activate
+    virtualenv venv
+    . venv/bin/activate
     ```
     _Note: venv\Scripts\activate for windows_
 
 3. Install python packages required to build components.
     ```
-    $ pip install -r requirements.txt
+    pip install .[dependencies]
     ```
 4. Install the python packages for testing (optional)
     ```
-    $ pip install -r tests/requirements.txt
+    pip install .[tests]
+    pip install dash[testing]
     ```
+    The second of these commands appears to be necessary as long as
+    [this `pip` issue is open](https://github.com/pypa/pip/issues/4957).
 
-### Write your component code in `src/lib/components/WebvizCoreComponents.react.js`.
+### Write component code in `src/lib/components/<component_name>.react.js`
 
 - The demo app is in `src/demo` and you will import your example component code into your demo app.
 - Test your code in a Python environment:
     1. Build your code
         ```
-        $ npm run build
+        npm run build:all
         ```
     2. Run and modify the `usage.py` sample dash app:
         ```
-        $ python usage.py
+        python usage.py
         ```
-- Write tests for your component.
-    - A sample test is available in `tests/test_usage.py`, it will load `usage.py` and you can then automate interactions with selenium.
-    - Run the tests with `$ pytest tests`.
-    - The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
-- Add custom styles to your component by putting your custom CSS files into your distribution folder (`webviz_core_components`).
-    - Make sure that they are referenced in `MANIFEST.in` so that they get properly included when you're ready to publish your component.
-    - Make sure the stylesheets are added to the `_css_dist` dict in `webviz_core_components/__init__.py` so dash will serve them automatically when the component suite is requested.
-- [Review your code](./review_checklist.md)
-
-### Create a production build and publish:
-
-1. Build your code:
-    ```
-    $ npm run build
-    ```
-2. Create a Python tarball
+-   Write tests for your component.
+    -   A sample test is available in `tests/test_usage.py`, it will load
+        `usage.py` and you can then automate interactions with selenium.
+
+    -   Run the tests with `pytest tests`.
+
+    -   The Dash team uses these types of integration tests extensively.
+        Browse the Dash component code on GitHub for more examples of testing
+        (e.g. [dash-core-components](https://github.com/plotly/dash-core-components)).
+
+-   Add custom styles to your component by putting your custom CSS files into
+    your distribution folder (`webviz_subsurface_components`).
+    -   Make sure that they are referenced in `MANIFEST.in` so that they get
+        properly included when you're ready to publish your component.
+
+    -   Make sure the stylesheets are added to the `_css_dist` dict in
+        `webviz_core_components/__init__.py` so dash will serve them
+        automatically when the component suite is requested.
+
+-   [Review your code](./review_checklist.md)
+
+### Build code and install
+
+1.  Build your code:
     ```
-    $ python setup.py sdist
+    npm run build:all
     ```
-    This distribution tarball will get generated in the `dist/` folder
-
-3. Test your tarball by copying it into a new environment and installing it locally:
+2.  Install the Python package:
     ```
-    $ pip install webviz_core_components-0.0.1.tar.gz
+    python setup.py install
     ```
-
-4. If it works, then you can publish the component to NPM and PyPI:
-    1. Publish on PyPI
-        ```
-        $ twine upload dist/*
-        ```
-    2. Cleanup the dist folder (optional)
-        ```
-        $ rm -rf dist
-        ```
-    3. Publish on NPM (Optional if chosen False in `publish_on_npm`)
-        ```
-        $ npm publish
-        ```
-        _Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash serves the component library's CSS and JS locally, but if you choose to publish the package to NPM you can set `serve_locally` to `False` and you may see faster load times._
-
-5. Share your component with the community! https://community.plot.ly/c/dash
-    1. Publish this repository to GitHub
-    2. Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
-    3. Create a post in the Dash community forum: https://community.plot.ly/c/dash

package.json

@@ -1,6 +1,5 @@
 {
   "name": "webviz_core_components",
-  "version": "0.0.1",
   "description": "Core components for webviz config",
   "repository": {
     "type": "git",

requirements.txt

@@ -1,10 +1,58 @@
+import os
+import json
 from setuptools import setup
 
+
+with open('README.md', 'r') as fh:
+    long_description = fh.read()
+
+with open(os.path.join('webviz_core_components', 'package-info.json')) as f:
+    package = json.load(f)
+
+package_name = package['name'].replace(' ', '_').replace('-', '_')
+
+install_requires = [
+    'dash~=1.0.1'
+]
+
+tests_require = [
+    'chromedriver-binary>=74.0.3729.6.0',
+    'ipdb',
+    'percy',
+    'selenium',
+    'flake8',
+    'pylint'
+]
+
+# 'dash[testing]' to be added in tests_require when
+# https://github.com/pypa/pip/issues/4957 is closed.
+
 setup(
-    name="webviz_core_components",
-    author="R&T Equinor",
-    packages=["webviz_core_components"],
+    name=package_name,
+    author=package['author'],
+    packages=[package_name],
     include_package_data=True,
-    license="LGPLv3",
-    install_requires=[]
+    license=package['license'],
+    description=package['description'],
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/equinor/webviz-core-components',
+    install_requires=install_requires,
+    tests_require=tests_require,
+    extras_require={
+        'tests': tests_require,
+        'dependencies': install_requires
+    },
+    setup_requires=['setuptools_scm>=3.2.0'],
+    use_scm_version=True,
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'Operating System :: OS Independent',
+        'Natural Language :: English',
+        'Topic :: Multimedia :: Graphics',
+        'Topic :: Scientific/Engineering',
+        'Topic :: Scientific/Engineering :: Visualization',
+        'License :: OSI Approved :: '\
+        'GNU Lesser General Public License v3 (LGPLv3)'
+    ]
 )

setup.py

@@ -0,0 +1,17 @@
+import dash
+import dash_html_components as html
+import webviz_core_components
+
+def test_container_placeholder(dash_duo):
+
+    app = dash.Dash(__name__)
+
+    app.layout = html.Div([
+        webviz_core_components.WebvizContainerPlaceholder(
+            id='container',
+            children=['Hello world']
+        ),
+        html.Div(id='output')
+    ])
+
+    dash_duo.start_server(app)

tests/requirements.txt

@@ -4,12 +4,20 @@
 import sys as _sys
 import json
 
+from pkg_resources import get_distribution, DistributionNotFound
+
 import dash as _dash
 
 # noinspection PyUnresolvedReferences
 from ._imports_ import *
 from ._imports_ import __all__
 
+try:
+    __version__ = get_distribution(__name__).version
+except DistributionNotFound:
+    # package is not installed
+    pass
+
 if not hasattr(_dash, 'development'):
     print('Dash was not successfully imported. '
           'Make sure you don\'t have a file '
@@ -22,7 +30,6 @@
     package = json.load(f)
 
 package_name = package['name'].replace(' ', '_').replace('-', '_')
-__version__ = package['version']
 
 _current_path = _os.path.dirname(_os.path.abspath(__file__))
 

tests/test_container_placeholder.py

@@ -1,6 +1,5 @@
 {
   "name": "webviz_core_components",
-  "version": "0.0.1",
   "description": "Core components for webviz config",
   "repository": {
     "type": "git",