From 345fb01a45a62b250230c746bc5f8f06e31c65da Mon Sep 17 00:00:00 2001 From: T-Lind Date: Sun, 4 Dec 2022 17:15:06 -0600 Subject: [PATCH] setup for pypi publishing --- LICENSE.txt | 20 ++++++++++++++++++++ README.md | 2 +- setup.cfg | 3 +++ setup.py | 40 ++++++++++++++++++++++++++++------------ 4 files changed, 52 insertions(+), 13 deletions(-) create mode 100644 LICENSE.txt create mode 100644 setup.cfg diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..361d6b5 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,20 @@ +Copyright (c) 2022 Tiernan Lindauer + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 2e1757e..9e51699 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# MotorLib: A configurable library for 12V DC Motors +# MotorLib: A configurable library for 12V DC Motors ### Author: Tiernan Lindauer MotorLib is for use with any microcontroller/computer that has GPIO, like the popular Raspberry Pi or Arduino boards. diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..8c99867 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,3 @@ +[metadata] +description-file=README.md +license_files=LICENSE.rst \ No newline at end of file diff --git a/setup.py b/setup.py index 726a5c3..7b35710 100644 --- a/setup.py +++ b/setup.py @@ -1,17 +1,33 @@ from setuptools import setup, find_packages +import codecs +import os +here = os.path.abspath(os.path.dirname(__file__)) + +with codecs.open(os.path.join(here, "README.md"), encoding="utf-8") as fh: + long_description = "\n" + fh.read() + +VERSION = '0.3' +DESCRIPTION = '12V Motor control for robotics.' +LONG_DESCRIPTION = '' + +# Setting up setup( - name='MotorLib', - version='0.1', - license='MIT', + name="pymotorlib", + version=VERSION, author="Tiernan Lindauer", - author_email='tiernanxkl@gmail.com', - packages=find_packages('MotorLib'), - package_dir={'': 'MotorLib'}, - url='https://github.com/T-Lind/MotorLib', - keywords='Robotics', - install_requires=[ - 'RPi.GPIO', - ], - + author_email="", + description=DESCRIPTION, + long_description_content_type="text/markdown", + long_description=long_description, + packages=find_packages(), + install_requires=['RPi.GPIO'], + keywords=['python', 'robotics', 'motors'], + classifiers=[ + "Intended Audience :: Developers", + "Programming Language :: Python :: 3", + "Operating System :: Unix", + "Operating System :: MacOS :: MacOS X", + "Operating System :: Microsoft :: Windows", + ] ) \ No newline at end of file