Mercurial > genshi > mirror

annotate setup.py @ 382:2682dabbcd04 trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Added documentation for the various stream event kinds. * Move generation of HTML documentation into a custom distutils command, run by `setup.py build_doc` * Added verification of doctest snippets in documentation, which can be run by `setup.py test_doc` * Fixed `repr` of `Markup` instances.
author cmlenz
date Fri, 01 Dec 2006 23:43:59 +0000
parents 7763f7aec949
children cab6b0256019
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
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
23
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
24
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
25 class test_doc(Command):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
26 description = 'Tests the code examples in the documentation'
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
27 user_options = []
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
28
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
29 def initialize_options(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
30 pass
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
31
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
32 def finalize_options(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
33 pass
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
34
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
35 def run(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
36 for filename in glob('doc/*.txt'):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
37 print 'testing documentation file %s' % filename
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
38 doctest.testfile(filename, False, optionflags=doctest.ELLIPSIS)
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
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
41 class build_doc(Command):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
42 description = 'Builds the documentation'
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
43 user_options = []
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
44
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
45 def initialize_options(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
46 pass
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
47
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
48 def finalize_options(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
49 pass
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
50
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
51 def run(self):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
52 from docutils.core import publish_cmdline
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
53 conf = os.path.join('doc', 'docutils.conf')
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
54
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
55 for source in glob('doc/*.txt'):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
56 dest = os.path.splitext(source)[0] + '.html'
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
57 if not os.path.exists(dest) or \
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
58 os.path.getmtime(dest) < os.path.getmtime(source):
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
59 print 'building documentation file %s' % dest
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
60 publish_cmdline(writer_name='html',
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
61 argv=['--config=%s' % conf, source, dest])
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
62
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
63
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
64 setup(
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
65 name = 'Genshi',
255
8fdd14e35664 Bump version number on trunk.
cmlenz
parents: 230
diff changeset
66 version = '0.4',
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
67 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
68 long_description = \
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
69 """Genshi is a Python library that provides an integrated set of components
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
70 for parsing, generating, and processing HTML, XML or other textual content for
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
71 output generation on the web. The major feature is a template language, which
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
72 is heavily inspired by Kid.""",
148
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
73 author = 'Edgewall Software',
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
74 author_email = 'info@edgewall.org',
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
75 license = 'BSD',
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
76 url = 'http://genshi.edgewall.org/',
256
693a228bf1c7 Fix download URL.
cmlenz
parents: 255
diff changeset
77 download_url = 'http://genshi.edgewall.org/wiki/Download',
148
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
78 zip_safe = True,
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
79
124
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
80 classifiers = [
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
81 'Development Status :: 4 - Beta',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
82 'Environment :: Web Environment',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
83 'Intended Audience :: Developers',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
84 'License :: OSI Approved :: BSD License',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
85 'Operating System :: OS Independent',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
86 'Programming Language :: Python',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
87 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
88 'Topic :: Software Development :: Libraries :: Python Modules',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
89 'Topic :: Text Processing :: Markup :: HTML',
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
90 'Topic :: Text Processing :: Markup :: XML'
a9a8db67bb5a Add Trove classifiers and download URL to `setup.py`.
cmlenz
parents: 84
diff changeset
91 ],
215
94120e6b0ce4 A couple of minor XPath fixes.
cmlenz
parents: 189
diff changeset
92 keywords = ['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
93 packages = ['genshi', 'genshi.template'],
230
84168828b074 Renamed Markup to Genshi in repository.
cmlenz
parents: 215
diff changeset
94 test_suite = 'genshi.tests.suite',
84
0a1843b2c096 Make dependency of the setup script on setuptools optional.
cmlenz
parents: 66
diff changeset
95
148
dcc9dc25bc59 Added changelog file, plus some README and setup tweaks.
cmlenz
parents: 145
diff changeset
96 extras_require = {'plugin': ['setuptools>=0.6a2']},
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
97 entry_points = """
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
98 [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
99 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
100 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
101 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
102 """,
382
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
103
2682dabbcd04 * Added documentation for the various stream event kinds.
cmlenz
parents: 336
diff changeset
104 cmdclass={'build_doc': build_doc, 'test_doc': test_doc}
1
5479aae32f5a Initial import.
cmlenz
parents:
diff changeset
105 )
Copyright (C) 2012-2017 Edgewall Software