Skip to main content

Add autometa keyword to setuptools.setup for automatic version, description andlong_desctiption.

Project description

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

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

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

And in test/__init__.py:

"""First line of docstring.

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

It will parse specified module file or package’s __init__.py and set version to its __version__ attribute, description to first line of its docstring, and long_description to the rest of the docstring.

NOTE Please note, that version is parsed by running ast.literal_eval <https://docs.python.org/3/library/ast.html?highlight=ast#ast.literal_eval> on the right side of assignment to __version__, so keep in mind that it can only be a string literal , or a list/tuple of string/integer literals.

Additionally you can whitelist which fields are to be parsed by using autometa_fields keyword argument and setting it to an iterable of field names.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Setuptools_Autometa-0.1.0-py2.py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page