Skip to content
This repository was archived by the owner on Dec 26, 2019. It is now read-only.

Commit 1eac54f

Browse files
committed
clarify README.rst, fix setup.cfg
1 parent dae89e7 commit 1eac54f

File tree

3 files changed

+61
-3
lines changed

3 files changed

+61
-3
lines changed

ChangeLog

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
CHANGES
2+
=======
3+
4+
* clarify README.rst, fix setup.cfg
5+
6+
0.1.4
7+
-----
8+
9+
* Make button label a traitlet
10+
* fix typo
11+
12+
0.1.3
13+
-----
14+
15+
* add missing \`install\` instruction
16+
* cleanup
17+
* update installation instructions
18+
* add Jupyter extensions hooks
19+
* Update requirements.txt
20+
* Update README.rst
21+
* update README
22+
23+
0.1.1
24+
-----
25+
26+
* fixes #4
27+
28+
0.1
29+
---
30+
31+
* Add shields.io badges
32+
* update setup.cfg, add dev requirements
33+
* Set the universal flag
34+
* closes #3
35+
* Use PY2 compatible super call
36+
* migrate to \`notebook\` 4.0
37+
* \`data\` is now a bytes string
38+
* Update installation instruction
39+
* Install into user directory if system fails
40+
* use a label element
41+
* Use a fake button w/ a nested file input
42+
* add IPython dependency requirement
43+
* update README
44+
* add decode method
45+
* add view and model
46+
* initial commit, scaffold

README.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,14 @@ Installation
1717
Install using pip::
1818

1919
pip install fileupload
20-
jupyter nbextension install --py fileupload
21-
jupyter nbextension enable --py fileupload
20+
21+
Install JavaScript::
22+
23+
jupyter nbextension install [--user] --py fileupload
24+
25+
Enable the extension::
26+
27+
jupyter nbextension enable [--user] --py fileupload
2228

2329
Usage
2430
-----
@@ -49,4 +55,10 @@ Base64 data is synced to the ``data_base64`` member, decoded data can be
4955
obtained from ``data``.
5056
The name of the uploaded file is stored in ``filename``.
5157

58+
Changelog
59+
---------
60+
61+
Refer to Changelog_.
62+
5263
.. _FileReader: https://developer.mozilla.org/en-US/docs/Web/API/FileReader
64+
.. _Changelog: ./ChangeLog

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author = Alain Péteut
44
author-email = [email protected]
55
home-page = https://github.com/peteut/ipython-file-upload
66
summary = IPython file upload widget
7-
description = README.rst
7+
description-file = README.rst
88
license = MIT
99
classifier =
1010
Development Status :: 4 - Beta

0 commit comments

Comments
 (0)