Created
February 26, 2018 14:29
-
-
Save holtgrewe/6a7cc33426f64cf78ee9be22f9e4ee26 to your computer and use it in GitHub Desktop.
MWE for setup.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env python | |
# -*- coding: utf-8 -*- | |
# Note: To use the 'upload' functionality of this file, you must: | |
# $ pip install twine | |
import io | |
import os | |
import sys | |
from shutil import rmtree | |
from setuptools import find_packages, setup, Command | |
# Package meta-data. | |
NAME = 'mypackage' | |
DESCRIPTION = 'My short description for my project.' | |
URL = 'https://github.com/me/myproject' | |
EMAIL = '[email protected]' | |
AUTHOR = 'Awesome Soul' | |
REQUIRES_PYTHON = '>=3.6.0' | |
VERSION = None | |
# What packages are required for this module to be executed? | |
REQUIRED = [ | |
# 'requests', 'maya', 'records', | |
] | |
# The rest you shouldn't have to touch too much :) | |
# ------------------------------------------------ | |
# Except, perhaps the License and Trove Classifiers! | |
# If you do change the License, remember to change the Trove Classifier for that! | |
here = os.path.abspath(os.path.dirname(__file__)) | |
# Import the README and use it as the long-description. | |
# Note: this will only work if 'README.rst' is present in your MANIFEST.in file! | |
with io.open(os.path.join(here, 'README.rst'), encoding='utf-8') as f: | |
long_description = '\n' + f.read() | |
# Load the package's __version__.py module as a dictionary. | |
about = {} | |
if not VERSION: | |
with open(os.path.join(here, NAME, '__version__.py')) as f: | |
exec(f.read(), about) | |
else: | |
about['__version__'] = VERSION | |
class UploadCommand(Command): | |
"""Support setup.py upload.""" | |
description = 'Build and publish the package.' | |
user_options = [] | |
@staticmethod | |
def status(s): | |
"""Prints things in bold.""" | |
print('\033[1m{0}\033[0m'.format(s)) | |
def initialize_options(self): | |
pass | |
def finalize_options(self): | |
pass | |
def run(self): | |
try: | |
self.status('Removing previous builds…') | |
rmtree(os.path.join(here, 'dist')) | |
except OSError: | |
pass | |
self.status('Building Source and Wheel (universal) distribution…') | |
os.system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable)) | |
self.status('Uploading the package to PyPi via Twine…') | |
os.system('twine upload dist/*') | |
self.status('Pushing git tags…') | |
os.system('git tag v{0}'.format(about['__version__'])) | |
os.system('git push --tags') | |
sys.exit() | |
# Where the magic happens: | |
setup( | |
name=NAME, | |
version=about['__version__'], | |
description=DESCRIPTION, | |
long_description=long_description, | |
author=AUTHOR, | |
author_email=EMAIL, | |
python_requires=REQUIRES_PYTHON, | |
url=URL, | |
packages=find_packages(exclude=('tests',)), | |
# If your package is a single module, use this instead of 'packages': | |
# py_modules=['mypackage'], | |
# entry_points={ | |
# 'console_scripts': ['mycli=mymodule:cli'], | |
# }, | |
install_requires=REQUIRED, | |
include_package_data=True, | |
license='MIT', | |
classifiers=[ | |
# Trove classifiers | |
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers | |
'License :: OSI Approved :: MIT License', | |
'Programming Language :: Python', | |
'Programming Language :: Python :: 3', | |
'Programming Language :: Python :: 3.6', | |
'Programming Language :: Python :: Implementation :: CPython', | |
'Programming Language :: Python :: Implementation :: PyPy' | |
], | |
# $ setup.py publish support. | |
cmdclass={ | |
'upload': UploadCommand, | |
}, | |
) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment