diff --git a/.npmignore b/.npmignore index 69227a1..524e16c 100644 --- a/.npmignore +++ b/.npmignore @@ -23,3 +23,5 @@ config .travis.yml CHANGELOG.md README.md + +*venv \ No newline at end of file diff --git a/DESCRIPTION b/DESCRIPTION index 1bdb34e..453630c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: dashVtk Title: React based declarative usage of vtk.js for Dash -Version: 0.0.1 +Version: 0.0.2 Description: React based declarative usage of vtk.js for Dash Depends: R (>= 3.0.2) Imports: diff --git a/Project.toml b/Project.toml index 34d5d2f..947d1ac 100644 --- a/Project.toml +++ b/Project.toml @@ -1,8 +1,8 @@ name = "DashVtk" uuid = "1b08a953-4be3-4667-9a23-818b1eccd4c7" -authors = ["Kitware Inc "] -version = "0.0.1" +authors = ["Kitware Inc and Plotly Technologies "] +version = "0.0.2" [deps] Dash = "1b08a953-4be3-4667-9a23-3db579824955" diff --git a/R/internal.R b/R/internal.R index 2ffc58a..73c801e 100644 --- a/R/internal.R +++ b/R/internal.R @@ -1,12 +1,12 @@ .dashVtk_js_metadata <- function() { deps_metadata <- list(`dash_vtk` = structure(list(name = "dash_vtk", -version = "0.0.1", src = list(href = NULL, +version = "0.0.2", src = list(href = NULL, file = "deps"), meta = NULL, script = 'dash_vtk.min.js', stylesheet = NULL, head = NULL, attachment = NULL, package = "dashVtk", all_files = FALSE), class = "html_dependency"), `dash_vtk` = structure(list(name = "dash_vtk", -version = "0.0.1", src = list(href = NULL, +version = "0.0.2", src = list(href = NULL, file = "deps"), meta = NULL, script = 'dash_vtk.min.js.map', stylesheet = NULL, head = NULL, attachment = NULL, package = "dashVtk", diff --git a/dash_vtk/package-info.json b/dash_vtk/package-info.json index a68b4d6..0c24488 100644 --- a/dash_vtk/package-info.json +++ b/dash_vtk/package-info.json @@ -1,6 +1,6 @@ { "name": "dash_vtk", - "version": "0.0.1", + "version": "0.0.2", "description": "React based declarative usage of vtk.js for Dash", "repository": { "type": "git", @@ -21,7 +21,7 @@ "build": "npm run build:js && npm run build:py_and_r", "build:activated": "npm run build:js && npm run build:py_and_r-activated" }, - "author": "Kitware Inc ", + "author": "Kitware Inc and Plotly Technologies ", "license": "MIT", "dependencies": { "ramda": "^0.26.1", @@ -54,5 +54,12 @@ "engines": { "node": ">=8.11.0", "npm": ">=6.1.0" - } -} + }, + "files": [ + "dash_vtk", + "src", + "README.md", + "docs", + "dist" + ] +} \ No newline at end of file diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 6724460..97fd4a6 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [0.0.1] - 2021-01-?? +## [0.0.2] - 2021-01-29 + +### Added + +* PyPi description auto-generated from `README.md` + +### Changed +* Use `package.json`'s files instead of `npmignore` +* Change order of instructions in `docs/CONTRIBUTING.md` + +### Fixed +* Update `setup.py` to include `utils` directory when upload to PyPi. + + +## [0.0.1] - 2021-01-29 This is the initial release. \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0bf628d..b6ba640 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -115,30 +115,31 @@ python setup.py sdist ``` 6. Copy the tarball into a separate folder and try to install it and run the examples: ``` -cp dist/dash_vtk-x.x.x.tar.gz ../temp -cp usage.py ../temp -cd ../temp -source venv/bin/activate -pip install dash_vtk-x.x.x.tar.gz +virtualenv venv-release +source venv-release/bin/activate +pip install dist/dash_vtk-x.x.x.tar.gz python usage.py +rm -r venv-release/ # Clean up after you are done ``` 7. If the examples work, then publish: ``` +npm login # only if you are not already logged in npm publish twine upload dist/dash_vtk-x.x.x.tar.gz ``` -8. Tag your release with git: -``` -git tag -a 'vx.x.x' -m 'vx.x.x' -git push origin master --follow-tags -``` -9. Verify that the publish worked by installing it: + +8. Verify that the publish worked by installing it: ``` cd ../temp pip install dash-vtk==x.x.x python usage.py ``` +9. Tag your release with git: +``` +git tag -a 'vx.x.x' -m 'vx.x.x' +git push origin master --follow-tags +``` Make a post in the [Dash Community Forum](https://community.plotly.com/c/dash) * Title it `":mega: Announcement! New - Feedback Welcome"` diff --git a/package.json b/package.json index a68b4d6..0c24488 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "dash_vtk", - "version": "0.0.1", + "version": "0.0.2", "description": "React based declarative usage of vtk.js for Dash", "repository": { "type": "git", @@ -21,7 +21,7 @@ "build": "npm run build:js && npm run build:py_and_r", "build:activated": "npm run build:js && npm run build:py_and_r-activated" }, - "author": "Kitware Inc ", + "author": "Kitware Inc and Plotly Technologies ", "license": "MIT", "dependencies": { "ramda": "^0.26.1", @@ -54,5 +54,12 @@ "engines": { "node": ">=8.11.0", "npm": ">=6.1.0" - } -} + }, + "files": [ + "dash_vtk", + "src", + "README.md", + "docs", + "dist" + ] +} \ No newline at end of file diff --git a/setup.py b/setup.py index 2525316..faea3ab 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ +import io import json import os -from setuptools import setup +from setuptools import setup, find_packages with open('package.json') as f: @@ -12,10 +13,13 @@ name=package_name, version=package["version"], author=package['author'], - packages=[package_name], + packages=find_packages(include=[package_name, package_name + ".*"]), include_package_data=True, license=package['license'], description=package.get('description', package_name), + long_description=io.open('README.md', encoding='utf-8').read(), + long_description_content_type='text/markdown', + url='https://github.com/plotly/dash-vtk', install_requires=['dash'], classifiers=[ 'Environment :: Web Environment', diff --git a/src/DashVtk.jl b/src/DashVtk.jl index 3e3c35f..27b39d3 100644 --- a/src/DashVtk.jl +++ b/src/DashVtk.jl @@ -3,7 +3,7 @@ module DashVtk using Dash const resources_path = realpath(joinpath( @__DIR__, "..", "deps")) -const version = "0.0.1" +const version = "0.0.2" include("vtk_algorithm.jl") include("vtk_calculator.jl") @@ -34,14 +34,14 @@ function __init__() [ DashBase.Resource( relative_package_path = "dash_vtk.min.js", - external_url = "https://unpkg.com/dash_vtk@0.0.1/dash_vtk/dash_vtk.min.js", + external_url = "https://unpkg.com/dash_vtk@0.0.2/dash_vtk/dash_vtk.min.js", dynamic = nothing, async = nothing, type = :js ), DashBase.Resource( relative_package_path = "dash_vtk.min.js.map", - external_url = "https://unpkg.com/dash_vtk@0.0.1/dash_vtk/dash_vtk.min.js.map", + external_url = "https://unpkg.com/dash_vtk@0.0.2/dash_vtk/dash_vtk.min.js.map", dynamic = true, async = nothing, type = :js