Mercurial > genshi > mirror

annotate setup.py @ 530:78039a4c2f57 trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add extra for I18n.
author cmlenz
date Wed, 20 Jun 2007 09:56:24 +0000
parents 24df908da22d
children 773d8c470e82
rev   line source
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
1 #!/usr/bin/env python
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
2 # -*- coding: utf-8 -*-
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
3 #
66
59eb24184e9c Switch copyright to Edgewall and URLs to markup.edgewall.org.
cmlenz
parents: 27
diff changeset
4 # Copyright (C) 2006 Edgewall Software
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
5 # All rights reserved.
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
6 #
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
7 # This software is licensed as described in the file COPYING, which
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
8 # you should have received as part of this distribution. The terms
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
9 # are also available at http://genshi.edgewall.org/wiki/License.
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
10 #
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
11 # This software consists of voluntary contributions made by many
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
12 # individuals. For the exact contribution history, see the revision
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
13 # history and logs, available at http://genshi.edgewall.org/log/.
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
14
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
15 from distutils.cmd import Command
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
16 import doctest
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
17 from glob import glob
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
18 import os
84
0a1843b2c096 Make dependency of the setup script on setuptools optional.
cmlenz
parents: 66
diff changeset
19 try:
145
47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples.
cmlenz
parents: 129
diff changeset
20 from setuptools import setup
84
0a1843b2c096 Make dependency of the setup script on setuptools optional.
cmlenz
parents: 66
diff changeset
21 except ImportError:
0a1843b2c096 Make dependency of the setup script on setuptools optional.
cmlenz
parents: 66
diff changeset
22 from distutils.core import setup
426
a1955bc39924 Add epydoc-based API doc generation to the build.
cmlenz
parents: 394
diff changeset
23 import sys
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
24
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
25
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
26 class build_doc(Command):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
27 description = 'Builds the documentation'
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
28 user_options = [
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
29 ('force', None,
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
30 "force regeneration even if no reStructuredText files have changed"),
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
31 ('without-apidocs', None,
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
32 "whether to skip the generation of API documentaton"),
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
33 ]
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
34 boolean_options = ['force', 'without-apidocs']
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
35
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
36 def initialize_options(self):
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
37 self.force = False
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
38 self.without_apidocs = False
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
39
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
40 def finalize_options(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
41 pass
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
42
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
43 def run(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
44 from docutils.core import publish_cmdline
508
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
45 from docutils.nodes import raw
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
46 from docutils.parsers import rst
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
47
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
48 docutils_conf = os.path.join('doc', 'conf', 'docutils.ini')
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
49 epydoc_conf = os.path.join('doc', 'conf', 'epydoc.ini')
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
50
508
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
51 try:
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
52 from pygments import highlight
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
53 from pygments.lexers import get_lexer_by_name
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
54 from pygments.formatters import HtmlFormatter
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
55
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
56 def code_block(name, arguments, options, content, lineno,
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
57 content_offset, block_text, state, state_machine):
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
58 lexer = get_lexer_by_name(arguments[0])
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
59 html = highlight('\n'.join(content), lexer, HtmlFormatter())
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
60 return [raw('', html, format='html')]
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
61 code_block.arguments = (1, 0, 0)
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
62 code_block.options = {'language' : rst.directives.unchanged}
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
63 code_block.content = 1
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
64 rst.directives.register_directive('code-block', code_block)
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
65 except ImportError:
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
66 print 'Pygments not installed, syntax highlighting disabled'
5fbc1cde74d6 Enable syntax highlighting (with Pygments) on doc page.
cmlenz
parents: 492
diff changeset
67
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
68 for source in glob('doc/*.txt'):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
69 dest = os.path.splitext(source)[0] + '.html'
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
70 if self.force or not os.path.exists(dest) or \
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
71 os.path.getmtime(dest) < os.path.getmtime(source):
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
72 print 'building documentation file %s' % dest
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
73 publish_cmdline(writer_name='html',
426
a1955bc39924 Add epydoc-based API doc generation to the build.
cmlenz
parents: 394
diff changeset
74 argv=['--config=%s' % docutils_conf, source,
a1955bc39924 Add epydoc-based API doc generation to the build.
cmlenz
parents: 394
diff changeset
75 dest])
a1955bc39924 Add epydoc-based API doc generation to the build.
cmlenz
parents: 394
diff changeset
76
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
77 if not self.without_apidocs:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
78 try:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
79 from epydoc import cli
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
80 old_argv = sys.argv[1:]
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
81 sys.argv[1:] = [
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
82 '--config=%s' % epydoc_conf,
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
83 '--no-private', # epydoc bug, not read from config
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
84 '--simple-term',
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
85 '--verbose'
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
86 ]
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
87 cli.cli()
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
88 sys.argv[1:] = old_argv
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
89
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
90 except ImportError:
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
91 print 'epydoc not installed, skipping API documentation.'
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
92
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
93
394
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
94 class test_doc(Command):
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
95 description = 'Tests the code examples in the documentation'
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
96 user_options = []
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
97
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
98 def initialize_options(self):
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
99 pass
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
100
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
101 def finalize_options(self):
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
102 pass
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
103
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
104 def run(self):
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
105 for filename in glob('doc/*.txt'):
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
106 print 'testing documentation file %s' % filename
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
107 doctest.testfile(filename, False, optionflags=doctest.ELLIPSIS)
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
108
cab6b0256019 Minor doc fixes.
cmlenz
parents: 382
diff changeset
109
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
110 setup(
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
111 name = 'Genshi',
455
190ffd36b6bb Bump up version number on trunk.
cmlenz
parents: 452
diff changeset
112 version = '0.5',
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
113 description = 'A toolkit for stream-based generation of output for the web',
148
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
114 long_description = \
452
a89368769b82 Add `filters` package in `setup.py`.
cmlenz
parents: 426
diff changeset
115 """Genshi is a Python library that provides an integrated set of
a89368769b82 Add `filters` package in `setup.py`.
cmlenz
parents: 426
diff changeset
116 components for parsing, generating, and processing HTML, XML or
a89368769b82 Add `filters` package in `setup.py`.
cmlenz
parents: 426
diff changeset
117 other textual content for output generation on the web. The major
a89368769b82 Add `filters` package in `setup.py`.
cmlenz
parents: 426
diff changeset
118 feature is a template language, which is heavily inspired by Kid.""",
148
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
119 author = 'Edgewall Software',
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
120 author_email = 'info@edgewall.org',
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
121 license = 'BSD',
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
122 url = 'http://genshi.edgewall.org/',
256
693a228bf1c7 Fix download URL.
cmlenz
parents: 255
diff changeset
123 download_url = 'http://genshi.edgewall.org/wiki/Download',
148
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
124 zip_safe = True,
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
125
124
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
126 classifiers = [
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
127 'Development Status :: 4 - Beta',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
128 'Environment :: Web Environment',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
129 'Intended Audience :: Developers',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
130 'License :: OSI Approved :: BSD License',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
131 'Operating System :: OS Independent',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
132 'Programming Language :: Python',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
133 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
134 'Topic :: Software Development :: Libraries :: Python Modules',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
135 'Topic :: Text Processing :: Markup :: HTML',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
136 'Topic :: Text Processing :: Markup :: XML'
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
137 ],
215
94120e6b0ce4 A couple of minor XPath fixes.
cmlenz
parents: 189
diff changeset
138 keywords = ['python.templating.engines'],
452
a89368769b82 Add `filters` package in `setup.py`.
cmlenz
parents: 426
diff changeset
139 packages = ['genshi', 'genshi.filters', 'genshi.template'],
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
140 test_suite = 'genshi.tests.suite',
84
0a1843b2c096 Make dependency of the setup script on setuptools optional.
cmlenz
parents: 66
diff changeset
141
530
78039a4c2f57 Add extra for I18n.
cmlenz
parents: 528
diff changeset
142 extras_require = {
78039a4c2f57 Add extra for I18n.
cmlenz
parents: 528
diff changeset
143 'i18n': ['Babel>=0.8'],
78039a4c2f57 Add extra for I18n.
cmlenz
parents: 528
diff changeset
144 'plugin': ['setuptools>=0.6a2']
78039a4c2f57 Add extra for I18n.
cmlenz
parents: 528
diff changeset
145 },
4
49364e784c47 Added first stab of an implementation of the !TurboGears [http://www.turbogears.org/docs/plugins/template.html plugin API for template engines], and also a !TurboGears-based example using this plugin. Both written by Matt Good.
cmlenz
parents: 1
diff changeset
146 entry_points = """
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
147 [babel.extractors]
530
78039a4c2f57 Add extra for I18n.
cmlenz
parents: 528
diff changeset
148 genshi = genshi.filters.i18n:extract[i18n]
528
24df908da22d Integrated [http://babel.edgewall.org/ Babel] message extraction plugin, and added I18n doc page.
cmlenz
parents: 508
diff changeset
149
4
49364e784c47 Added first stab of an implementation of the !TurboGears [http://www.turbogears.org/docs/plugins/template.html plugin API for template engines], and also a !TurboGears-based example using this plugin. Both written by Matt Good.
cmlenz
parents: 1
diff changeset
150 [python.templating.engines]
336
7763f7aec949 Refactoring: `genshi.template` is now a package, it was getting way to crowded in that file.
cmlenz
parents: 265
diff changeset
151 genshi = genshi.template.plugin:MarkupTemplateEnginePlugin[plugin]
7763f7aec949 Refactoring: `genshi.template` is now a package, it was getting way to crowded in that file.
cmlenz
parents: 265
diff changeset
152 genshi-markup = genshi.template.plugin:MarkupTemplateEnginePlugin[plugin]
7763f7aec949 Refactoring: `genshi.template` is now a package, it was getting way to crowded in that file.
cmlenz
parents: 265
diff changeset
153 genshi-text = genshi.template.plugin:TextTemplateEnginePlugin[plugin]
4
49364e784c47 Added first stab of an implementation of the !TurboGears [http://www.turbogears.org/docs/plugins/template.html plugin API for template engines], and also a !TurboGears-based example using this plugin. Both written by Matt Good.
cmlenz
parents: 1
diff changeset
154 """,
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
155
492
fd10321bb1ba Fix docstring typo.
cmlenz
parents: 455
diff changeset
156 cmdclass = {'build_doc': build_doc, 'test_doc': test_doc}
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
157 )
Copyright (C) 2012-2017 Edgewall Software