Skip to content

Commit 28d345a

Browse files
author
Xing Han Lu
authored
Post-v0.0.1 Fixes - Release v0.0.2 (#14)
* Ignore more folders for npm publishing * Specify Date for Changelog * Slightly improve contributing guidelines * Auto-include README in setup.py's long description * use package.json's files instead of npmignore * Update version and add authors * Fix setup.py's packages to include utils * Update changelog
1 parent a3d0f91 commit 28d345a

10 files changed

+65
-30
lines changed

‎.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ config
2323
.travis.yml
2424
CHANGELOG.md
2525
README.md
26+
27+
*venv

‎DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: dashVtk
22
Title: React based declarative usage of vtk.js for Dash
3-
Version: 0.0.1
3+
Version: 0.0.2
44
Description: React based declarative usage of vtk.js for Dash
55
Depends: R (>= 3.0.2)
66
Imports:

‎Project.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
name = "DashVtk"
33
uuid = "1b08a953-4be3-4667-9a23-818b1eccd4c7"
4-
authors = ["Kitware Inc <[email protected]>"]
5-
version = "0.0.1"
4+
authors = ["Kitware Inc <[email protected]> and Plotly Technologies <[email protected]>"]
5+
version = "0.0.2"
66

77
[deps]
88
Dash = "1b08a953-4be3-4667-9a23-3db579824955"

‎R/internal.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
.dashVtk_js_metadata <- function() {
22
deps_metadata <- list(`dash_vtk` = structure(list(name = "dash_vtk",
3-
version = "0.0.1", src = list(href = NULL,
3+
version = "0.0.2", src = list(href = NULL,
44
file = "deps"), meta = NULL,
55
script = 'dash_vtk.min.js',
66
stylesheet = NULL, head = NULL, attachment = NULL, package = "dashVtk",
77
all_files = FALSE), class = "html_dependency"),
88
`dash_vtk` = structure(list(name = "dash_vtk",
9-
version = "0.0.1", src = list(href = NULL,
9+
version = "0.0.2", src = list(href = NULL,
1010
file = "deps"), meta = NULL,
1111
script = 'dash_vtk.min.js.map',
1212
stylesheet = NULL, head = NULL, attachment = NULL, package = "dashVtk",

‎dash_vtk/package-info.json

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dash_vtk",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "React based declarative usage of vtk.js for Dash",
55
"repository": {
66
"type": "git",
@@ -21,7 +21,7 @@
2121
"build": "npm run build:js && npm run build:py_and_r",
2222
"build:activated": "npm run build:js && npm run build:py_and_r-activated"
2323
},
24-
"author": "Kitware Inc <[email protected]>",
24+
"author": "Kitware Inc <[email protected]> and Plotly Technologies <[email protected]>",
2525
"license": "MIT",
2626
"dependencies": {
2727
"ramda": "^0.26.1",
@@ -54,5 +54,12 @@
5454
"engines": {
5555
"node": ">=8.11.0",
5656
"npm": ">=6.1.0"
57-
}
58-
}
57+
},
58+
"files": [
59+
"dash_vtk",
60+
"src",
61+
"README.md",
62+
"docs",
63+
"dist"
64+
]
65+
}

‎docs/CHANGELOG.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9-
## [0.0.1] - 2021-01-??
9+
## [0.0.2] - 2021-01-29
10+
11+
### Added
12+
13+
* PyPi description auto-generated from `README.md`
14+
15+
### Changed
16+
* Use `package.json`'s files instead of `npmignore`
17+
* Change order of instructions in `docs/CONTRIBUTING.md`
18+
19+
### Fixed
20+
* Update `setup.py` to include `utils` directory when upload to PyPi.
21+
22+
23+
## [0.0.1] - 2021-01-29
1024

1125
This is the initial release.

‎docs/CONTRIBUTING.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -115,30 +115,31 @@ python setup.py sdist
115115
```
116116
6. Copy the tarball into a separate folder and try to install it and run the examples:
117117
```
118-
cp dist/dash_vtk-x.x.x.tar.gz ../temp
119-
cp usage.py ../temp
120-
cd ../temp
121-
source venv/bin/activate
122-
pip install dash_vtk-x.x.x.tar.gz
118+
virtualenv venv-release
119+
source venv-release/bin/activate
120+
pip install dist/dash_vtk-x.x.x.tar.gz
123121
python usage.py
122+
rm -r venv-release/ # Clean up after you are done
124123
```
125124
7. If the examples work, then publish:
126125
```
126+
npm login # only if you are not already logged in
127127
npm publish
128128
twine upload dist/dash_vtk-x.x.x.tar.gz
129129
```
130-
8. Tag your release with git:
131-
```
132-
git tag -a 'vx.x.x' -m 'vx.x.x'
133-
git push origin master --follow-tags
134-
```
135-
9. Verify that the publish worked by installing it:
130+
131+
8. Verify that the publish worked by installing it:
136132
```
137133
cd ../temp
138134
pip install dash-vtk==x.x.x
139135
python usage.py
140136
```
141137

138+
9. Tag your release with git:
139+
```
140+
git tag -a 'vx.x.x' -m 'vx.x.x'
141+
git push origin master --follow-tags
142+
```
142143

143144
Make a post in the [Dash Community Forum](https://community.plotly.com/c/dash)
144145
* Title it `":mega: Announcement! New <Your Feature> - Feedback Welcome"`

‎package.json

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dash_vtk",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "React based declarative usage of vtk.js for Dash",
55
"repository": {
66
"type": "git",
@@ -21,7 +21,7 @@
2121
"build": "npm run build:js && npm run build:py_and_r",
2222
"build:activated": "npm run build:js && npm run build:py_and_r-activated"
2323
},
24-
"author": "Kitware Inc <[email protected]>",
24+
"author": "Kitware Inc <[email protected]> and Plotly Technologies <[email protected]>",
2525
"license": "MIT",
2626
"dependencies": {
2727
"ramda": "^0.26.1",
@@ -54,5 +54,12 @@
5454
"engines": {
5555
"node": ">=8.11.0",
5656
"npm": ">=6.1.0"
57-
}
58-
}
57+
},
58+
"files": [
59+
"dash_vtk",
60+
"src",
61+
"README.md",
62+
"docs",
63+
"dist"
64+
]
65+
}

‎setup.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
import io
12
import json
23
import os
3-
from setuptools import setup
4+
from setuptools import setup, find_packages
45

56

67
with open('package.json') as f:
@@ -12,10 +13,13 @@
1213
name=package_name,
1314
version=package["version"],
1415
author=package['author'],
15-
packages=[package_name],
16+
packages=find_packages(include=[package_name, package_name + ".*"]),
1617
include_package_data=True,
1718
license=package['license'],
1819
description=package.get('description', package_name),
20+
long_description=io.open('README.md', encoding='utf-8').read(),
21+
long_description_content_type='text/markdown',
22+
url='https://github.com/plotly/dash-vtk',
1923
install_requires=['dash'],
2024
classifiers=[
2125
'Environment :: Web Environment',

‎src/DashVtk.jl

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module DashVtk
33
using Dash
44

55
const resources_path = realpath(joinpath( @__DIR__, "..", "deps"))
6-
const version = "0.0.1"
6+
const version = "0.0.2"
77

88
include("vtk_algorithm.jl")
99
include("vtk_calculator.jl")
@@ -34,14 +34,14 @@ function __init__()
3434
[
3535
DashBase.Resource(
3636
relative_package_path = "dash_vtk.min.js",
37-
external_url = "https://unpkg.com/[email protected].1/dash_vtk/dash_vtk.min.js",
37+
external_url = "https://unpkg.com/[email protected].2/dash_vtk/dash_vtk.min.js",
3838
dynamic = nothing,
3939
async = nothing,
4040
type = :js
4141
),
4242
DashBase.Resource(
4343
relative_package_path = "dash_vtk.min.js.map",
44-
external_url = "https://unpkg.com/[email protected].1/dash_vtk/dash_vtk.min.js.map",
44+
external_url = "https://unpkg.com/[email protected].2/dash_vtk/dash_vtk.min.js.map",
4545
dynamic = true,
4646
async = nothing,
4747
type = :js

0 commit comments

Comments
 (0)