Skip to content

Commit 1fcb5d4

Browse files
committed
update readme due to api changes in save_to_memory which returns an io stream
1 parent c15e6a8 commit 1fcb5d4

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ You need to pass a StringIO instance to Writer:
203203
... ]
204204
>>> io = StringIO()
205205
>>> sheet = pe.Sheet(data)
206-
>>> sheet.save_to_memory("xlsx", io)
206+
>>> io = sheet.save_to_memory("xlsx", io)
207207
>>> # then do something with io
208208
>>> # In reality, you might give it to your http response
209209
>>> # object for downloading
@@ -220,6 +220,7 @@ Development steps for code changes
220220

221221
#. git clone https://github.com/pyexcel/pyexcel-xlsx.git
222222
#. cd pyexcel-xlsx
223+
#. pip install -r rnd_requirements.txt # if such a file exists
223224
#. pip install -r requirements.txt
224225
#. pip install -r tests/requirements.txt
225226

@@ -231,6 +232,20 @@ required:
231232
#. git clone https://github.com/pyexcel/pyexcel-commons.git
232233
#. make your changes in `.moban.d` directory, then issue command `moban`
233234

235+
What is rnd_requirements.txt
236+
-------------------------------
237+
238+
Usually, it is created when a depdent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.
239+
240+
What is pyexcel-commons
241+
---------------------------------
242+
243+
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
244+
245+
What is .moban.d
246+
---------------------------------
247+
248+
`.moban.d` stores the specific meta data for the library.
234249

235250
How to test your contribution
236251
------------------------------

0 commit comments

Comments
 (0)