diff options
Diffstat (limited to 'creole/setup_utils.py')
| -rw-r--r-- | creole/setup_utils.py | 50 |
1 files changed, 15 insertions, 35 deletions
diff --git a/creole/setup_utils.py b/creole/setup_utils.py index 24b1b1a..f7d1bfd 100644 --- a/creole/setup_utils.py +++ b/creole/setup_utils.py @@ -1,40 +1,12 @@ """ - utils for distutils setup + Python setup.py utilities ~~~~~~~~~~~~~~~~~~~~~~~~~ - Get README.creole as ReStructuredText on-the-fly for setup.long_description + Generate ReStructuredText README from README.creole. + Usable for other python packages, too. More information: - https://code.google.com/p/python-creole/wiki/UseInSetup - - usage in setup.py e.g.: - --------------------------------------------------------------------------- - #!/usr/bin/env python - # coding: utf-8 - - import os - import sys - from setuptools import setup, find_packages - - PACKAGE_ROOT = os.path.dirname(os.path.abspath(__file__)) - - try: - from creole.setup_utils import get_long_description - except ImportError: - if 'register' in sys.argv or 'sdist' in sys.argv or '--long-description' in sys.argv: - etype, evalue, etb = sys.exc_info() - evalue = etype('%s - Please install python-creole >= v0.8 - e.g.: pip install python-creole' % evalue) - raise etype, evalue, etb - long_description = None - else: - long_description = get_long_description(PACKAGE_ROOT) - - setup( - ... - long_description = long_description, - ... - ) - --------------------------------------------------------------------------- + https://github.com/jedie/python-creole/wiki/Use-In-Setup :copyleft: 2011-2020 by the python-creole team, see AUTHORS for more details. :license: GNU GPL v3 or above, see LICENSE for more details. @@ -51,6 +23,7 @@ from pathlib import Path from creole import __version__, creole2html, html2rest from creole.shared.unknown_tags import raise_unknown_node, transparent_unknown_nodes +from creole.tests.test_project_setup import test_version RAISE_ERRORS_ARGS = ( 'check', 'register', 'sdist', 'bdist', 'upload', @@ -160,17 +133,23 @@ def update_rst_readme(package_root, filename='README.creole'): with rest_readme_path.open('w') as f: f.write(rest_readme) + + # Add a note about generation with modification time from source: + f.write('\n\n------------\n\n') - dt = datetime.datetime.utcnow() + + modification_time = creole_readme_path.stat().st_mtime + dt = datetime.datetime.fromtimestamp(modification_time) dt = dt.replace(microsecond=0) dt = dt.isoformat(sep=' ') - f.write(f'``Note: this file is generated from {filename} with "python-creole" at {dt}``') + f.write(f'``Note: this file is generated from {filename} {dt} with "python-creole"``') print('done.') + return rest_readme_path def update_creole_rst_readme(): - update_rst_readme( + return update_rst_readme( package_root=Path(__file__).parent.parent, filename='README.creole' ) @@ -336,6 +315,7 @@ def publish_python_creole(): Call this via: $ poetry run publish """ + test_version() poetry_publish( package_root=Path(__file__).parent.parent, version=__version__, |