Command extensions for SetupTools setup scripts.
- Imports:
- cStringIO, datetime, distutils.errors, glob, misclibs.functional, misclibs.util, os, os.path, rstlib.astdoc, setuptools, sys, traclib
- Classes:
- build_license(Command): generate LICENSE files from package metadata
- build_readme(Command): generate README files from package metadata
- rst2html(Command): generate HTML from reStructured text files
- rstdocs(Command): generate python documentation from module sources
- Attributes:
- INSTALLATION = '\nTo build and install from a source distribution execute\nthe following as root from the root directory of the \ndistribution::\n\n # python setup.py install\n\n \nThe following commands can be useful if you wish to modify\nthe package::\n \n # python setup.py rstdocs (Build python documentation from module sources)\n # python setup.py build_readme (Build README files from package Metadata)\n # python setup.py build_license (Build LICENSE files from package Metadata)\n # python setup.py rst2html (Convert reStrunctured text files to html)\n \nFor additional help execute one of the following commands::\n \n python setup.py --help (for general help)\n python setup.py --help-commands (for a list of commands)\n python setup.py command --help (for help on a specific command)\n'
- LICENSES = { }
- LICENSES['MIT'] = '\nThe %s package is distributed under the terms of the MIT license:\n\nThe MIT License\n\nCopyright (c) <year> <copyright holders>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n'
- __all__ = ['build_docs', 'rst2html', 'build_readme', 'build_license']
Back to setuplib
- Bases:
- Command
generate LICENSE files from package metadata
- Methods:
- finalize_options(self):
- initialize_options(self):
- run(self):
- Attributes:
- boolean_options = []
- description = __doc__.strip()
- user_options = [('copyright=', None, 'Copyright text')]
Back to setuplib
- Bases:
- Command
generate README files from package metadata
- Methods:
- finalize_options(self):
- initialize_options(self):
- run(self):
- Attributes:
- boolean_options = []
- description = __doc__.strip()
- user_options = []
Back to setuplib
- Bases:
- Command
generate HTML from reStructured text files
- Methods:
- finalize_options(self):
- initialize_options(self):
- run(self):
- Attributes:
- boolean_options = []
- command_consumes_arguments = True
- description = __doc__.strip()
- user_options = []
Back to setuplib
- Bases:
- Command
generate python documentation from module sources
- Methods:
- finalize_options(self):
- initialize_options(self):
- run(self):
- Attributes:
- boolean_options = ['no-status']
- command_consumes_arguments = True
- description = __doc__.strip()
- user_options = [('path=', 'p', 'Path to docs directory'), ('title=', None, 'The title of the Package index'), ('trac=', None, 'The Trac project URL'), ('no-status', None, 'Supress status messages')]