Skip to content

Commit 4550229

Browse files
committed
bump version + some tweaks to readme and setup.py
1 parent 893d0e2 commit 4550229

File tree

3 files changed

+23
-5
lines changed

3 files changed

+23
-5
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
1+
![CI](https://github.com/pygfx/wgpu-py/workflows/CI/badge.svg)
2+
13
# dash_slicer
24

35
A volume slicer for Dash
46

57

6-
The API is currently a WIP.
8+
## Status
9+
10+
This work is marked as alpha - some essential features are still in
11+
development, and some parts of the API may change in future releases.
712

813

914
## Installation
1015

11-
Eventually, this would be pip-installable. For now, use the developer workflow.
16+
```
17+
$ pip install dash-slicer
18+
```
19+
20+
Dash-slicer depends on Python 3.6+ plus some [dependencies](requirements.txt).
1221

1322

1423
## Usage example

dash_slicer/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
from .slicer import VolumeSlicer # noqa: F401
77

88

9-
__version__ = "0.0.1"
9+
__version__ = "0.1.0"
1010
version_info = tuple(map(int, __version__.split(".")))

setup.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
"""
2+
Setup script to distribute dash-slicer.
3+
4+
* clear your dist dir
5+
* python setup.py sdist bdist_wheel
6+
* twine upload dist/*
7+
"""
8+
19
import re
210

311
from setuptools import find_packages, setup
@@ -23,11 +31,11 @@
2331
install_requires=runtime_deps,
2432
license="MIT",
2533
description=SUMMARY,
26-
long_description=open("README.md").read(),
2734
long_description_content_type="text/markdown",
35+
long_description=open("README.md").read(),
2836
author="Plotly",
2937
author_email="[email protected]",
30-
# url="https://github.com/plotly/will be renamed?",
38+
url="https://github.com/plotly/dash-slicer",
3139
data_files=[("", ["LICENSE"])],
3240
zip_safe=True, # not if we put JS in a seperate file, I think
3341
classifiers=[
@@ -37,5 +45,6 @@
3745
"Programming Language :: Python :: 3",
3846
"Topic :: Software Development :: Libraries :: Python Modules",
3947
"Topic :: Scientific/Engineering :: Visualization",
48+
"Topic :: Software Development :: User Interfaces",
4049
],
4150
)

0 commit comments

Comments
 (0)