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.post2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e12ae2f584dd24868f8d25c4eb4816cc01414d77c4451401e2be8cc3335a48ed |
|
MD5 | 689b7280c239e5cfcaa05194df4d798e |
|
BLAKE2b-256 | 38fb962f9a7e9f4786c63da64b18b2ad1877cb467eee513409d70abcd33ffd49 |
Hashes for Setuptools_Autometa-0.1.1.post2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8f8c2e3d9ab454139a3a259d4139f3df86d4b06fd2cc8c0e54882dc61e5424c |
|
MD5 | b20690f8c5717b9fd64028e4db5d4121 |
|
BLAKE2b-256 | d04d0b915e55b3cb585a14f6c4ae89e9177e88dfd12240e62daf07db2b1e8e3e |
Hashes for Setuptools_Autometa-0.1.1.post2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d52a5fa742f68e152581075ea4fbf7d4668b60216f36e10f5ce7335d53b43647 |
|
MD5 | 484cf68c95a54da3a204aac57ee94dfb |
|
BLAKE2b-256 | a9b9f06303137fb830a01eb557594a4b3bdc5e6d5ae0cb8f422f8ae019fcac00 |