From dc8a5e5f164e3d3e317cbfd27b61897aaaac0e1c Mon Sep 17 00:00:00 2001 From: William Turner Date: Wed, 27 Sep 2017 11:19:13 -0400 Subject: [PATCH] Rework package for PyPI release Resolves #1 --- .gitignore | 2 + LICENSE.txt | 165 ++++++++++++++++++++++++++++++++++++++++++++++++++++ MANIFEST | 9 --- README.md | 40 +++++++------ setup.cfg | 2 + setup.py | 51 +++++++++++++--- 6 files changed, 233 insertions(+), 36 deletions(-) create mode 100644 LICENSE.txt delete mode 100644 MANIFEST create mode 100644 setup.cfg diff --git a/.gitignore b/.gitignore index 7c65fc6..74a2340 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ *.pyd *.pyo *.sublime-* +*.egg-info +*.rst build dist venv diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/MANIFEST b/MANIFEST deleted file mode 100644 index e02ebdd..0000000 --- a/MANIFEST +++ /dev/null @@ -1,9 +0,0 @@ -# file GENERATED by distutils, do NOT edit -setup.py -pyxlsb\__init__.py -pyxlsb\biff12.py -pyxlsb\handlers.py -pyxlsb\reader.py -pyxlsb\stringtable.py -pyxlsb\workbook.py -pyxlsb\worksheet.py diff --git a/README.md b/README.md index f2856a1..6ddb31f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,33 @@ -PyXLSB +pyxlsb ====== -PyXLSB is an Excel 2007-2010 Binary Workbook (XLSB / BIFF12) parser for Python. -The library is currently extremely limited, but functional enough for basic data extraction. +[![PyPI](https://img.shields.io/pypi/v/pyxlsb.svg)](https://pypi.python.org/pypi/pyxlsb) + +`pyxlsb` is an Excel 2007-2010 Binary Workbook (xlsb) parser for Python. +The library is currently extremely limited, but functional enough for basic +data extraction. + +Install +------- + +```bash +pip install pyxlsb +``` Usage ----- -The module exposes an `open_workbook(name)` method (similar to Xlrd and OpenPyXl) for opening XLSB files. -The Workbook object representing the file is returned. +The module exposes an `open_workbook(name)` method (similar to Xlrd and +OpenPyXl) for opening XLSB files. The Workbook object representing the file is +returned. ```python import pyxlsb wb = pyxlsb.open_workbook('workbook.xlsb') ``` -The Workbook object exposes a `get_sheet(idx)` method for retrieving a Worksheet instance. +The Workbook object exposes a `get_sheet(idx)` method for retrieving a +Worksheet instance. ```python # Using the sheet index (1-based) @@ -25,7 +37,8 @@ sheet = wb.get_sheet(1) sheet = wb.get_sheet('Sheet1') ``` -Tip: A `sheets` property containing the sheet names is available on the Workbook instance. +Tip: A `sheets` property containing the sheet names is available on the +Workbook instance. The `rows()` method will hand out an iterator to read the worksheet rows. @@ -34,18 +47,9 @@ for row in sheet.rows(): print(row) ``` -Do note that dates will appear as `float`s. -You must use the `convert_date(date)` method from the `pyxlsb` module to turn them into `datetime` instances. +Do note that dates will appear as floats. You must use the `convert_date(date)` +method from the `pyxlsb` module to turn them into `datetime` instances. ```python print(pyxlsb.convert_date(41235.45578)) ``` - -Install -------- - -Download or checkout the repository and run the `setup.py` script as usual. - -```bash -python setup.py install -``` diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..3c6e79c --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[bdist_wheel] +universal=1 diff --git a/setup.py b/setup.py index 5dcba2c..7189f37 100644 --- a/setup.py +++ b/setup.py @@ -1,9 +1,42 @@ -from distutils.core import setup - -setup(name='PyXLSB', - version='1.0.1', - description='Excel 2007-2010 Binary Workbook (BIFF12) parser', - author='William Turner', - author_email='willtur.will@gmail.com', - url='https://github.com/wwwiiilll/pyxlsb', - packages=['pyxlsb']) +import os.path +from setuptools import setup +from subprocess import Popen, PIPE + +# Get a handy base dir +project_dir = os.path.abspath(os.path.dirname(__file__)) + +# Use pandoc to convert the Markdown readme to RST for prtty printing on PyPI +proc = Popen(['pandoc', '--from', 'markdown', '--to', 'rst', '--output', '-', os.path.join(project_dir, 'README.md')], stdout=PIPE) +README = proc.stdout.read().decode('utf-8') +proc.stdout.close() +proc.wait() + +setup( + name='pyxlsb', + version='1.0.1', + + description='Excel 2007-2010 Binary Workbook (xlsb) parser', + long_description=README, + + author='William Turner', + author_email='willtur.will@gmail.com', + + url='https://github.com/wwwiiilll/pyxlsb', + + license='LGPLv3+', + + classifiers=[ + 'Development Status :: 5 - Production/Stable', + + 'License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)', + + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5' + ], + + packages=['pyxlsb'] +)