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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for Setuptools-Autometa-0.1.1.post3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2befc8aab0a7f73bb87835750f2daa5aaea7859ca113fbc8205e88eab0df0745 |
|
MD5 | c17dc2f5bf54f05cb39ff9c519c79eac |
|
BLAKE2b-256 | 28c636a7d55f487b1bfe39e24181a1e84ea7a49f3db9eb8610b2fb061e8d0395 |
Hashes for Setuptools_Autometa-0.1.1.post3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0978f94b1cf72e46a4ed9d3acb399d7b8da0bd5e3d044a99175eda99c6387a0 |
|
MD5 | 04f9f85b7abba8778508d662e68c5ebc |
|
BLAKE2b-256 | 5890d84383a39d258085308aa84f4bb9bd97430eb3fae77da1e9aa16f44ba277 |
Hashes for Setuptools_Autometa-0.1.1.post3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37d3a2c9010f927b3508211e4c8cc431e30b115716fdc7ec1b2b6915552977cb |
|
MD5 | 1864d1e9dd6f10b194ca8bda80bfe03c |
|
BLAKE2b-256 | 24f6bf4621450022f105cf6d87baae283f56ec853b381e4ca06cc59d58b1ec7a |