1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

#!/usr/bin/env python
# Copyright 2010 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from distutils.core import setup
import os
import re

NAME='key-train'
VER='0.1.4'
DIR='src/keytrain'
PY_NAME='key_train'
DEB_NAME=NAME.replace('-', '')
RELEASE_FILE='docs/RELEASE.rst'

PY_SRC='%s.py' % PY_NAME
DEPENDS=['python-yaml']
DEPENDS_STR=''.join(DEPENDS)
AUTHOR_NAME='Scott Kirkwood'
COPYRIGHT_NAME='Google Inc.'
GOOGLE_CODE_EMAIL='scott@forusers.com'
KEYWORDS=['keyboard', 'training', 'education']
MAN_FILE='man/%s.1' % NAME
DESKTOP_FILE=None
ICON=None
COMMAND='/usr/bin/%s' % NAME

def read(*rnames):
  return open(os.path.join(os.path.dirname(__file__), *rnames)).read()

SETUP = dict(
  name = NAME,
  version = VER,
  packages = ['keytrain'],
  package_dir = {
    'keytrain': 'src/keytrain'},
  package_data = {
    'keytrain': [
        'stats/*',
        'locale/**/**/*',
        'articles/**/**/*',
        '*.txt',
        '*.yaml',
        '*.svg',
        '*.png',
        'images/*',
        '*.kbd'],
  },
  scripts=['src/key-train'],
  author=AUTHOR_NAME,
  author_email='scott+keytrain@forusers.com',
  platforms=['POSIX'],
  license='Apache 2.0',
  keywords=' '.join(KEYWORDS),
  url='http://code.google.com/p/%s' % NAME,
  download_url='http://%s.googlecode.com/files/%s-%s.zip' % (NAME, NAME, VER),
  classifiers=[
    'Development Status :: 4 - Beta',
    'Environment :: X11 Applications',
    'Intended Audience :: Education',
    'License :: OSI Approved :: Apache Software License',
    'Operating System :: POSIX :: Linux',
    'Topic :: Education',
  ],
  description='A typing tutor for touch typing',
  long_description="""Keyboard Training Software (for Linux)
A keyboard training program which I'm designing for my 8 year old son.
This is a keyboard training program (i.e. typing tutor) for touch typing, still in it's early days.
Goals:
Open source and open community.
Various languages supported (although not right to left nor logographic writing systems = ex. Kanji) (todo)
Various international keyboards supported and probably dvorak keyboards as well. (todo)
Attractive interface. (todo)
Scalable graphics, make the window as small or as large as you like.
Show the beginner typist where they should place their fingers. (todo)
Interesting text for advanced users instead of just random gibberish. Will pull in text from Wikipedia entries, for
various languages. (todo)
Beginner levels will have random text, however, and they should focus on common bi=grams and trigrams of the language in
question, to build up muscle memory for common key combinations. (todo)
Random text should also start with very simple letter combinations, like two keys close together for training the first
time. (todo)
Stats and progression. (todo)
Heatmap of trouble keys for the student. (todo)
Auto build lessons to work on the trouble keys. (todo)
Lessons for the number keys and punctuation marks. (todo)
Start off without the space bar or the backspace key, add these keys later.
  """,
  #zip_safe=False,
  #install_requires=[
  #  "PyYAML >= 3.0"
  #],
)

COPYRIGHT = 'Copyright (C) 2010 %s' % (COPYRIGHT_NAME) # pylint: disable-msg=W0622
LICENSE_TITLE = 'Apache License'
LICENSE_SHORT = 'Apache'
LICENSE_VERSION = '2.0'
LICENSE_TITLE_AND_VERSION = '%s version %s' % (LICENSE_TITLE, LICENSE_VERSION)
LICENSE = '%s or any later version' % LICENSE_TITLE_AND_VERSION # pylint: disable-msg=W0622
LICENSE_TITLE_AND_VERSION_ABBREV = '%s v%s' % (LICENSE_SHORT, LICENSE_VERSION)
LICENSE_ABBREV = '%s+' % LICENSE_TITLE_AND_VERSION_ABBREV
LICENSE_URL = 'http://www.apache.org/licenses/LICENSE-2.0'
LICENSE_PATH = '/usr/share/common-licenses/Apache-2.0'
LICENSE_NOTICE = '''%(name)s is free software: you can redistribute it and/or modify
under the compliance of the License.

%(name)s is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.''' % dict(name=NAME)

LICENSE_NOTICE_HTML = '<p>%s</p>' % LICENSE_NOTICE.replace('\n\n', '</p><p>')
LICENSE_NOTICE_HTML = re.sub(r'<http([^>]*)>', r'<a href="http\1" target="_blank">http\1</a>', LICENSE_NOTICE_HTML)

if __name__ == '__main__':
  setup(**SETUP)