Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Add autometa keyword to the setuptools.setup function which automatically fills version, description and long_description keywords

Project description

To use it, pass the module (without .py), or the package name as the autometa keyword argument for setup():

#! /usr/bin/env python
from setuptools import setup

setup(
    autometa='test',
    name='Test',
    packages=['test'],
    ...
)

Setuptools-Autometa will parse the specified module or package’s __init__.py and set version to its __version__ attribute, description to the first line of its docstring, and long_description to the rest of the docstring. Additionally build_sphinx command’s version and release options will be set.

For example following package’s __init__.py:

"""First line of docstring.

Many
more
lines
of
docstring.
"""
__version__ = '1.2.3.dev0'  # alternatively: (1, 2, 3, 'dev0')

Is equivalent to writing:

setup(
    version='1.2.3.dev0',
    description='First line of docstring',
    long_description='Many\nmore\nlines\nof\ndocstring.'
    ...
)

NOTE: Please note, that the version is parsed by running ast.literal_eval on the right side of the assignment to __version__, so keep in mind that it can only be a string literal, or a list/tuple of string/integer literals.

NOTE: Setuptools-Autometa assumes a PEP 0257 compliant docstring, that is its first line has to end with a period and be separated from the description by a blank line.

Additionally you can whitelist which fields are to be parsed by using the autometa_fields keyword argument and setting it to an iterable of field names (‘description’, ‘long_description’, ‘version’).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Setuptools_Autometa-0.1.1.post3-py2-none-any.whl (7.1 kB) Copy SHA256 hash SHA256 Wheel 2.7 Nov 6, 2015
Setuptools_Autometa-0.1.1.post3-py3-none-any.whl (7.1 kB) Copy SHA256 hash SHA256 Wheel 3.4 Nov 6, 2015
Setuptools-Autometa-0.1.1.post3.tar.gz (3.8 kB) Copy SHA256 hash SHA256 Source None Nov 6, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page