From a012c7151b8dd33ae1e96acd9b5ced364d89ccca Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Sun, 28 Feb 2016 12:27:52 +0000 Subject: [PATCH] Tidy up distribution, bumped version --- LICENSE.txt | 165 ++++++++++++++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 7 ++- README | 59 ------------------- README.rst | 68 ---------------------- setup.cfg | 2 + setup.py | 4 +- 6 files changed, 174 insertions(+), 131 deletions(-) create mode 100644 LICENSE.txt delete mode 100644 README delete mode 100644 README.rst create mode 100644 setup.cfg 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.in b/MANIFEST.in index 90aeef1..bb5e72f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,7 @@ graft WiringPi/wiringPi graft WiringPi/devLib -include *.txt -include *.rst +include README.md +include LICENSE.txt +include setup.cfg +include wiringpi2.py +include wiringpi_wrap.c diff --git a/README b/README deleted file mode 100644 index 5194b61..0000000 --- a/README +++ /dev/null @@ -1,59 +0,0 @@ -WARNING: This is an in-development library, it will not be bug free and fully featured. - Please tweet @gadgetoid, find Gadgetoid in IRC, email Phil at Gadgetoid dot com, - or visit http://pi.gadgetoid.com/post/039-wiringpi-version-2-with-extra-python and - comment if you have any problems, suggestions, questions or words of support. - -WiringPi: An implementation of most of the Arduino Wiring - functions for the Raspberry Pi - -WiringPi2: WiringPi version 2 implements new functions for managing IO expanders. - -Testing: - Build with gcc version 4.6.3 (Debian 4.6.3-14+rpi1) - Built against Python 2.7.2, Python 3.2.3 - -Prerequisites: - You must have python-dev and python-setuptools installed - If you manually rebuild the bindings with swig -python wiringpi.i - -Get/setup repo: - git clone https://github.com/Gadgetoid/WiringPi2-Python.git - cd WiringPi2-Python - -Build & install with: - sudo python setup.py install - -Or Python 3 - sudo python3 setup.py install - -Class-based Usage: - No classes have been created for this version yet. - -Usage: - import wiringpi2 - wiringpi2.wiringPiSetup() // For sequential pin numbering, one of these MUST be called before using IO functions - OR - wiringpi2.wiringPiSetupSys() // For /sys/class/gpio with GPIO pin numbering - OR - wiringpi2.wiringPiSetupGpio() // For GPIO pin numbering - - Setting up IO expanders (This example was tested on a quick2wire board with one digital IO expansion board connected via I2C): - wiringpi2.mcp23017Setup(65,0x20) - wiringpi2.pinMode(65,1) - wiringpi2.digitalWrite(65,1) - - General IO: - wiringpi2.pinMode(1,1) // Set pin 1 to output - wiringpi2.digitalWrite(1,1) // Write 1 HIGH to pin 1 - wiringpi2.digitalRead(1) // Read pin 1 - - Bit shifting: - wiringpi2.shiftOut(1,2,0,123) // Shift out 123 (b1110110, byte 0-255) to data pin 1, clock pin 2 - - Serial: - serial = wiringpi2.serialOpen('/dev/ttyAMA0',9600) // Requires device/baud and returns an ID - wiringpi2.serialPuts(serial,"hello") - wiringpi2.serialClose(serial) // Pass in ID - -Full details at: - http://www.wiringpi.com diff --git a/README.rst b/README.rst deleted file mode 100644 index 790e468..0000000 --- a/README.rst +++ /dev/null @@ -1,68 +0,0 @@ -====== -WiringPi 2 for Python -====== - -WiringPi: An implementation of most of the Arduino Wiring - functions for the Raspberry Pi - -WiringPi2: WiringPi version 2 implements new functions for managing IO expanders. - -Testing: -======== -Build with gcc version 4.6.3 (Debian 4.6.3-14+rpi1) -Built against Python 2.7.2, Python 3.2.3 - -Prerequisites: -============== -You must have python-dev and python-setuptools installed -If you manually rebuild the bindings with swig -python wiringpi.i - -Get/setup repo: -=============== -git clone https://github.com/Gadgetoid/WiringPi2-Python.git -cd WiringPi2-Python - -Build & install with: -===================== -sudo python setup.py install - -Or Python 3 -sudo python3 setup.py install - -Class-based Usage: -================== -Description incoming! - -Usage: -====== -import wiringpi2 -wiringpi2.wiringPiSetup // For sequential pin numbering, one of these MUST be called before using IO functions -OR -wiringpi2.wiringPiSetupSys // For /sys/class/gpio with GPIO pin numbering -OR -wiringpi2.wiringPiSetupGpio // For GPIO pin numbering - -Setting up IO expanders (This example was tested on a quick2wire board with one digital IO expansion board connected via I2C): -wiringpi2.mcp23017Setup(65,0x20) -wiringpi2.pinMode(65,1) -wiringpi2.digitalWrite(65,1) - -General IO: ------------ -wiringpi2.pinMode(1,1) // Set pin 1 to output -wiringpi2.digitalWrite(1,1) // Write 1 HIGH to pin 1 -wiringpi2.digitalRead(1) // Read pin 1 - -Bit shifting: -------------- -wiringpi2.shiftOut(1,2,0,123) // Shift out 123 (b1110110, byte 0-255) to data pin 1, clock pin 2 - -Serial: -------- -serial = wiringpi2.serialOpen('/dev/ttyAMA0',9600) // Requires device/baud and returns an ID -wiringpi2.serialPuts(serial,"hello") -wiringpi2.serialClose(serial) // Pass in ID - -Full details at: ----------------- -http://www.wiringpi.com diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..b88034e --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md diff --git a/setup.py b/setup.py index 3c147c0..40c113b 100755 --- a/setup.py +++ b/setup.py @@ -11,14 +11,14 @@ _wiringpi2 = Extension( setup( name = 'wiringpi2', - version = '1.2.1', + version = '1.2.2', author = "Philip Howard", author_email = "phil@gadgetoid.com", url = 'https://github.com/Gadgetoid/WiringPi2-Python/', description = """A python interface to WiringPi 2.0 library which allows for easily interfacing with the GPIO pins of the Raspberry Pi. Also supports i2c and SPI""", - long_description=open('README').read(), + long_description=open('README.md').read(), ext_modules = [ _wiringpi2 ], py_modules = ["wiringpi2"], install_requires=[],