Skip to content

Commit be0c5cb

Browse files
committed
This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst
1 parent b199660 commit be0c5cb

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

README.rst

+41-41
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
================================================================================
2-
pyexcel-odsr - Let you focus on data, instead of ods format
2+
- Let you focus on data, instead of format
33
================================================================================
44

55
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
@@ -8,18 +8,18 @@ pyexcel-odsr - Let you focus on data, instead of ods format
88
.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
99
:target: https://awesome-python.com/#specific-formats-processing
1010

11-
.. image:: https://travis-ci.org/pyexcel/pyexcel-odsr.svg?branch=master
12-
:target: http://travis-ci.org/pyexcel/pyexcel-odsr
11+
.. image:: https://travis-ci.org//.svg?branch=
12+
:target: http://travis-ci.org//
1313

14-
.. image:: https://codecov.io/gh/pyexcel/pyexcel-odsr/branch/master/graph/badge.svg
15-
:target: https://codecov.io/gh/pyexcel/pyexcel-odsr
14+
.. image:: https://codecov.io/gh///branch/master/graph/badge.svg
15+
:target: https://codecov.io/gh//
1616

17-
.. image:: https://badge.fury.io/py/pyexcel-odsr.svg
18-
:target: https://pypi.org/project/pyexcel-odsr
17+
.. image:: https://badge.fury.io/py/.svg
18+
:target: https://pypi.org/project/
1919

2020

21-
.. image:: https://pepy.tech/badge/pyexcel-odsr/month
22-
:target: https://pepy.tech/project/pyexcel-odsr/month
21+
.. image:: https://pepy.tech/badge//month
22+
:target: https://pepy.tech/project//month
2323

2424

2525
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
@@ -61,19 +61,19 @@ Installation
6161
================================================================================
6262

6363

64-
You can install pyexcel-odsr via pip:
64+
You can install via pip:
6565

6666
.. code-block:: bash
6767
68-
$ pip install pyexcel-odsr
68+
$ pip install
6969
7070
7171
or clone it and install it:
7272

7373
.. code-block:: bash
7474
75-
$ git clone https://github.com/pyexcel/pyexcel-odsr.git
76-
$ cd pyexcel-odsr
75+
$ git clone https://github.com//.git
76+
$ cd
7777
$ python setup.py install
7878
7979
Usage
@@ -105,18 +105,18 @@ As a standalone library
105105
>>> data = OrderedDict() # from collections import OrderedDict
106106
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
107107
>>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]})
108-
>>> save_data("your_file.ods", data)
108+
>>> save_data("your_file.", data)
109109

110110

111-
Read from an ods file
111+
Read from an file
112112
********************************************************************************
113113

114114
Here's the sample code:
115115

116116
.. code-block:: python
117117
118-
>>> from pyexcel_odsr import get_data
119-
>>> data = get_data("your_file.ods")
118+
>>> from pyexcel_ import get_data
119+
>>> data = get_data("your_file.")
120120
>>> import json
121121
>>> print(json.dumps(data))
122122
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}
@@ -139,16 +139,16 @@ Here's the sample code:
139139

140140

141141

142-
Read from an ods from memory
142+
Read from an from memory
143143
********************************************************************************
144144

145145
Continue from previous example:
146146

147147
.. code-block:: python
148148
149149
>>> # This is just an illustration
150-
>>> # In reality, you might deal with ods file upload
151-
>>> # where you will read from requests.FILES['YOUR_ODS_FILE']
150+
>>> # In reality, you might deal with file upload
151+
>>> # where you will read from requests.FILES['YOUR__FILE']
152152
>>> data = get_data(io)
153153
>>> print(json.dumps(data))
154154
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [[7, 8, 9], [10, 11, 12]]}
@@ -159,7 +159,7 @@ Pagination feature
159159

160160

161161

162-
Let's assume the following file is a huge ods file:
162+
Let's assume the following file is a huge file:
163163

164164
.. code-block:: python
165165
@@ -174,29 +174,29 @@ Let's assume the following file is a huge ods file:
174174
>>> sheetx = {
175175
... "huge": huge_data
176176
... }
177-
>>> save_data("huge_file.ods", sheetx)
177+
>>> save_data("huge_file.", sheetx)
178178
179179
And let's pretend to read partial data:
180180

181181
.. code-block:: python
182182
183-
>>> partial_data = get_data("huge_file.ods", start_row=2, row_limit=3)
183+
>>> partial_data = get_data("huge_file.", start_row=2, row_limit=3)
184184
>>> print(json.dumps(partial_data))
185185
{"huge": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}
186186
187187
And you could as well do the same for columns:
188188

189189
.. code-block:: python
190190
191-
>>> partial_data = get_data("huge_file.ods", start_column=1, column_limit=2)
191+
>>> partial_data = get_data("huge_file.", start_column=1, column_limit=2)
192192
>>> print(json.dumps(partial_data))
193193
{"huge": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}
194194
195195
Obvious, you could do both at the same time:
196196

197197
.. code-block:: python
198198
199-
>>> partial_data = get_data("huge_file.ods",
199+
>>> partial_data = get_data("huge_file.",
200200
... start_row=2, row_limit=3,
201201
... start_column=1, column_limit=2)
202202
>>> print(json.dumps(partial_data))
@@ -205,26 +205,26 @@ Obvious, you could do both at the same time:
205205
.. testcode::
206206
:hide:
207207

208-
>>> os.unlink("huge_file.ods")
208+
>>> os.unlink("huge_file.")
209209

210210

211211
As a pyexcel plugin
212212
--------------------------------------------------------------------------------
213213

214214
No longer, explicit import is needed since pyexcel version 0.2.2. Instead,
215-
this library is auto-loaded. So if you want to read data in ods format,
215+
this library is auto-loaded. So if you want to read data in format,
216216
installing it is enough.
217217

218218

219-
Reading from an ods file
219+
Reading from an file
220220
********************************************************************************
221221

222222
Here is the sample code:
223223

224224
.. code-block:: python
225225
226226
>>> import pyexcel as pe
227-
>>> sheet = pe.get_book(file_name="your_file.ods")
227+
>>> sheet = pe.get_book(file_name="your_file.")
228228
>>> sheet
229229
Sheet 1:
230230
+---+---+---+
@@ -242,24 +242,24 @@ Here is the sample code:
242242
.. testcode::
243243
:hide:
244244

245-
>>> sheet.save_as("another_file.ods")
245+
>>> sheet.save_as("another_file.")
246246

247247

248248

249249
Reading from a IO instance
250250
********************************************************************************
251251

252-
You got to wrap the binary content with stream to get ods working:
252+
You got to wrap the binary content with stream to get working:
253253

254254
.. code-block:: python
255255
256256
>>> # This is just an illustration
257-
>>> # In reality, you might deal with ods file upload
258-
>>> # where you will read from requests.FILES['YOUR_ODS_FILE']
259-
>>> odsfile = "another_file.ods"
260-
>>> with open(odsfile, "rb") as f:
257+
>>> # In reality, you might deal with file upload
258+
>>> # where you will read from requests.FILES['YOUR__FILE']
259+
>>> file = "another_file."
260+
>>> with open(file, "rb") as f:
261261
... content = f.read()
262-
... r = pe.get_book(file_type="ods", file_content=content)
262+
... r = pe.get_book(file_type="", file_content=content)
263263
... print(r)
264264
...
265265
Sheet 1:
@@ -279,15 +279,15 @@ You got to wrap the binary content with stream to get ods working:
279279
License
280280
================================================================================
281281

282-
New BSD License
282+
License
283283

284284
Developer guide
285285
==================
286286

287287
Development steps for code changes
288288

289-
#. git clone https://github.com/pyexcel/pyexcel-odsr.git
290-
#. cd pyexcel-odsr
289+
#. git clone https://github.com/pyexcel/.git
290+
#. cd
291291

292292
Upgrade your setup tools and pip. They are needed for development and testing only:
293293

@@ -344,5 +344,5 @@ This library is based on the ods of messytables, Open Knowledge Foundation Ltd.
344344
:hide:
345345

346346
>>> import os
347-
>>> os.unlink("your_file.ods")
348-
>>> os.unlink("another_file.ods")
347+
>>> os.unlink("your_file.")
348+
>>> os.unlink("another_file.")

0 commit comments

Comments
 (0)