Add autometa keyword to setuptools.setup for automatic version, description and long_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'],
...
)
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
more
lines
of
docstring.'
...
)
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. Additionally build_sphinx command's version and release will be set.
**NOTE:** Please note, that version is parsed by running
`ast.literal_eval <https://docs.python.org/3/library/ast.html#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.
**NOTE:** Setuptools-Autometa assumes `PEP 0257 <https://www.python.org/dev/peps/pep-0257/>`_
compliant docstrings, that is first line has to end with a period and be separated from description
by a blank line.
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 ('description', 'long_description', 'version').
#! /usr/bin/env python
from setuptools import setup
setup(
autometa='test',
name='Test',
packages=['test'],
...
)
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
more
lines
of
docstring.'
...
)
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. Additionally build_sphinx command's version and release will be set.
**NOTE:** Please note, that version is parsed by running
`ast.literal_eval <https://docs.python.org/3/library/ast.html#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.
**NOTE:** Setuptools-Autometa assumes `PEP 0257 <https://www.python.org/dev/peps/pep-0257/>`_
compliant docstrings, that is first line has to end with a period and be separated from description
by a blank line.
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 ('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
Close
Hashes for Setuptools-Autometa-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec138d0bb89d8af3c3d35f91eb752500d43273e7a5227964cffd70426d66fe7f |
|
MD5 | 40af4b664a88e6a1ff20d32b5df21e73 |
|
BLAKE2b-256 | 211c4328af51e5b2751573ee5ea4fd4b5b6c64d45c997c0387deae8f93e2a3c1 |
Close
Hashes for Setuptools_Autometa-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6efc01a65f5c16d43be559c57cb53b4f3b09cec799c99cf72bc4b7c7a6275ef6 |
|
MD5 | d47b133bb10139186e386f4d2157cb08 |
|
BLAKE2b-256 | 069bfaead42fa93a7f9c692c82853298660d5dd9a772b858cdb92c750a19e902 |
Close
Hashes for Setuptools_Autometa-0.1.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef758192d2d7b0dbcee1db65b21d1ca983885a52f934c8ce2e5256d9c287094b |
|
MD5 | a8f8b57ea0d5aa00fed59a977162132e |
|
BLAKE2b-256 | 1510eb74a59b512a9da16c18cca04cce63eb25b3193d65198a62e14a1846d982 |