~flossmanuals/fm/debianizer : revision 1

1

#!/usr/bin/env python

2

""" flossmanuals-debianizer.py - Create Debs from DocBook files"""

3

4

5

## Matthew Gallagher <mattva01 at ubuntu dot com>

6

#

7

## This program program is free software: you can redistribute it and/or modify

8

## it under the terms of the GNU General Public License as published by

9

## the Free Software Foundation, either version 3 of the License, or

10

## (at your option) any later version.

11

#

12

## This program is distributed in the hope that it will be useful, but

13

## WITHOUT ANY WARRANTY; without even the implied warranty of

14

## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

15

## General Public License for more details.

16

#

17

## You should have received a copy of the GNU General Public License

18

## along with this program. If not, see <http://www.gnu.org/licenses/>.

19

#

20

21

22

from __future__ import with_statement

23

24

import os

25

import sys

26

import time

27

28

from subprocess import call

29

from optparse import OptionParser

30

31

README_DEBIAN_EXAMPLE = """

32

This package was generated by flossmanuals-debianizer v1.

33

"""

34

35

CONTROL_EXAMPLE = """Source: $PACKAGE-docs

36

Section: text

37

Priority: optional

38

Maintainer: MAINTAINER

39

Build-Depends: debhelper (>= 5.0.0), cdbs

40

Build-Depends-Indep: xsltproc, docbook-xsl, perl, perl-modules, gnome-doc-utils, docbook-xml, fdupes, bc

41

Standards-Version: 3.7.2

42

43

Package: $PACKAGE-docs

44

Architecture: all

45

Pre-Depends: dpkg (>= 1.10.24)

46

Depends: scrollkeeper, yelp

47

Description: The $PACKAGE Documentation Project

48

This package holds the FLOSSManuals documentation for the $PACKAGE. This is

49

maintained at http://flossmanuals.net

50

The documentation can be viewed using Yelp, the GNOME help browser.

51

"""

52

53

RULES_EXAMPLE= """#!/usr/bin/make -f

54

55

include /usr/share/cdbs/1/rules/debhelper.mk

56

57

58

59

common-binary-post-install-indep::

60

61

# Install the documents; skip documents which are less than 40% translated

62

mkdir -p debian/$PACKAGE-docs/usr/share/gnome/help/$PACKAGE; \

63

cp docs/* debian/$PACKAGE-docs/usr/share/gnome/help/$PACKAGE/; \

64

65

# Scrollkeeper loving

66

67

dh_scrollkeeper

68

"""

69

70

GPLv2 = """

71

72

GNU GENERAL PUBLIC LICENSE

73

Version 2, June 1991

74

75

76

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

77

Everyone is permitted to copy and distribute verbatim copies

78

of this license document, but changing it is not allowed.

79

80

Preamble

81

82

The licenses for most software are designed to take away your

83

freedom to share and change it. By contrast, the GNU General Public

84

License is intended to guarantee your freedom to share and change free

85

software--to make sure the software is free for all its users. This

86

General Public License applies to most of the Free Software

87

Foundation's software and to any other program whose authors commit to

88

using it. (Some other Free Software Foundation software is covered by

89

the GNU Lesser General Public License instead.) You can apply it to

90

your programs, too.

91

92

When we speak of free software, we are referring to freedom, not

93

price. Our General Public Licenses are designed to make sure that you

94

have the freedom to distribute copies of free software (and charge for

95

this service if you wish), that you receive source code or can get it

96

if you want it, that you can change the software or use pieces of it

97

in new free programs; and that you know you can do these things.

98

99

To protect your rights, we need to make restrictions that forbid

100

anyone to deny you these rights or to ask you to surrender the rights.

101

These restrictions translate to certain responsibilities for you if you

102

distribute copies of the software, or if you modify it.

103

104

For example, if you distribute copies of such a program, whether

105

gratis or for a fee, you must give the recipients all the rights that

106

you have. You must make sure that they, too, receive or can get the

107

source code. And you must show them these terms so they know their

108

rights.

109

110

We protect your rights with two steps: (1) copyright the software, and

111

(2) offer you this license which gives you legal permission to copy,

112

distribute and/or modify the software.

113

114

Also, for each author's protection and ours, we want to make certain

115

that everyone understands that there is no warranty for this free

116

software. If the software is modified by someone else and passed on, we

117

want its recipients to know that what they have is not the original, so

118

that any problems introduced by others will not reflect on the original

119

authors' reputations.

120

121

Finally, any free program is threatened constantly by software

122

patents. We wish to avoid the danger that redistributors of a free

123

program will individually obtain patent licenses, in effect making the

124

program proprietary. To prevent this, we have made it clear that any

125

patent must be licensed for everyone's free use or not licensed at all.

126

127

The precise terms and conditions for copying, distribution and

128

modification follow.

129

130

GNU GENERAL PUBLIC LICENSE

131

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

132

133

0. This License applies to any program or other work which contains

134

a notice placed by the copyright holder saying it may be distributed

135

under the terms of this General Public License. The "Program", below,

136

refers to any such program or work, and a "work based on the Program"

137

means either the Program or any derivative work under copyright law:

138

that is to say, a work containing the Program or a portion of it,

139

either verbatim or with modifications and/or translated into another

140

language. (Hereinafter, translation is included without limitation in

141

the term "modification".) Each licensee is addressed as "you".

142

143

Activities other than copying, distribution and modification are not

144

covered by this License; they are outside its scope. The act of

145

running the Program is not restricted, and the output from the Program

146

is covered only if its contents constitute a work based on the

147

Program (independent of having been made by running the Program).

148

Whether that is true depends on what the Program does.

149

150

1. You may copy and distribute verbatim copies of the Program's

151

source code as you receive it, in any medium, provided that you

152

conspicuously and appropriately publish on each copy an appropriate

153

copyright notice and disclaimer of warranty; keep intact all the

154

notices that refer to this License and to the absence of any warranty;

155

and give any other recipients of the Program a copy of this License

156

along with the Program.

157

158

You may charge a fee for the physical act of transferring a copy, and

159

you may at your option offer warranty protection in exchange for a fee.

160

161

2. You may modify your copy or copies of the Program or any portion

162

of it, thus forming a work based on the Program, and copy and

163

distribute such modifications or work under the terms of Section 1

164

above, provided that you also meet all of these conditions:

165

166

a) You must cause the modified files to carry prominent notices

167

stating that you changed the files and the date of any change.

168

169

b) You must cause any work that you distribute or publish, that in

170

whole or in part contains or is derived from the Program or any

171

part thereof, to be licensed as a whole at no charge to all third

172

parties under the terms of this License.

173

174

c) If the modified program normally reads commands interactively

175

when run, you must cause it, when started running for such

176

interactive use in the most ordinary way, to print or display an

177

announcement including an appropriate copyright notice and a

178

notice that there is no warranty (or else, saying that you provide

179

a warranty) and that users may redistribute the program under

180

these conditions, and telling the user how to view a copy of this

181

License. (Exception: if the Program itself is interactive but

182

does not normally print such an announcement, your work based on

183

the Program is not required to print an announcement.)

184

185

These requirements apply to the modified work as a whole. If

186

identifiable sections of that work are not derived from the Program,

187

and can be reasonably considered independent and separate works in

188

themselves, then this License, and its terms, do not apply to those

189

sections when you distribute them as separate works. But when you

190

distribute the same sections as part of a whole which is a work based

191

on the Program, the distribution of the whole must be on the terms of

192

this License, whose permissions for other licensees extend to the

193

entire whole, and thus to each and every part regardless of who wrote it.

194

195

Thus, it is not the intent of this section to claim rights or contest

196

your rights to work written entirely by you; rather, the intent is to

197

exercise the right to control the distribution of derivative or

198

collective works based on the Program.

199

200

In addition, mere aggregation of another work not based on the Program

201

with the Program (or with a work based on the Program) on a volume of

202

a storage or distribution medium does not bring the other work under

203

the scope of this License.

204

205

3. You may copy and distribute the Program (or a work based on it,

206

under Section 2) in object code or executable form under the terms of

207

Sections 1 and 2 above provided that you also do one of the following:

208

209

a) Accompany it with the complete corresponding machine-readable

210

source code, which must be distributed under the terms of Sections

211

1 and 2 above on a medium customarily used for software interchange; or,

212

213

b) Accompany it with a written offer, valid for at least three

214

years, to give any third party, for a charge no more than your

215

cost of physically performing source distribution, a complete

216

machine-readable copy of the corresponding source code, to be

217

distributed under the terms of Sections 1 and 2 above on a medium

218

customarily used for software interchange; or,

219

220

c) Accompany it with the information you received as to the offer

221

to distribute corresponding source code. (This alternative is

222

allowed only for noncommercial distribution and only if you

223

received the program in object code or executable form with such

224

an offer, in accord with Subsection b above.)

225

226

The source code for a work means the preferred form of the work for

227

making modifications to it. For an executable work, complete source

228

code means all the source code for all modules it contains, plus any

229

associated interface definition files, plus the scripts used to

230

control compilation and installation of the executable. However, as a

231

special exception, the source code distributed need not include

232

anything that is normally distributed (in either source or binary

233

form) with the major components (compiler, kernel, and so on) of the

234

operating system on which the executable runs, unless that component

235

itself accompanies the executable.

236

237

If distribution of executable or object code is made by offering

238

access to copy from a designated place, then offering equivalent

239

access to copy the source code from the same place counts as

240

distribution of the source code, even though third parties are not

241

compelled to copy the source along with the object code.

242

243

4. You may not copy, modify, sublicense, or distribute the Program

244

except as expressly provided under this License. Any attempt

245

otherwise to copy, modify, sublicense or distribute the Program is

246

void, and will automatically terminate your rights under this License.

247

However, parties who have received copies, or rights, from you under

248

this License will not have their licenses terminated so long as such

249

parties remain in full compliance.

250

251

5. You are not required to accept this License, since you have not

252

signed it. However, nothing else grants you permission to modify or

253

distribute the Program or its derivative works. These actions are

254

prohibited by law if you do not accept this License. Therefore, by

255

modifying or distributing the Program (or any work based on the

256

Program), you indicate your acceptance of this License to do so, and

257

all its terms and conditions for copying, distributing or modifying

258

the Program or works based on it.

259

260

6. Each time you redistribute the Program (or any work based on the

261

Program), the recipient automatically receives a license from the

262

original licensor to copy, distribute or modify the Program subject to

263

these terms and conditions. You may not impose any further

264

restrictions on the recipients' exercise of the rights granted herein.

265

You are not responsible for enforcing compliance by third parties to

266

this License.

267

268

7. If, as a consequence of a court judgment or allegation of patent

269

infringement or for any other reason (not limited to patent issues),

270

conditions are imposed on you (whether by court order, agreement or

271

otherwise) that contradict the conditions of this License, they do not

272

excuse you from the conditions of this License. If you cannot

273

distribute so as to satisfy simultaneously your obligations under this

274

License and any other pertinent obligations, then as a consequence you

275

may not distribute the Program at all. For example, if a patent

276

license would not permit royalty-free redistribution of the Program by

277

all those who receive copies directly or indirectly through you, then

278

the only way you could satisfy both it and this License would be to

279

refrain entirely from distribution of the Program.

280

281

If any portion of this section is held invalid or unenforceable under

282

any particular circumstance, the balance of the section is intended to

283

apply and the section as a whole is intended to apply in other

284

circumstances.

285

286

It is not the purpose of this section to induce you to infringe any

287

patents or other property right claims or to contest validity of any

288

such claims; this section has the sole purpose of protecting the

289

integrity of the free software distribution system, which is

290

implemented by public license practices. Many people have made

291

generous contributions to the wide range of software distributed

292

through that system in reliance on consistent application of that

293

system; it is up to the author/donor to decide if he or she is willing

294

to distribute software through any other system and a licensee cannot

295

impose that choice.

296

297

This section is intended to make thoroughly clear what is believed to

298

be a consequence of the rest of this License.

299

300

8. If the distribution and/or use of the Program is restricted in

301

certain countries either by patents or by copyrighted interfaces, the

302

original copyright holder who places the Program under this License

303

may add an explicit geographical distribution limitation excluding

304

those countries, so that distribution is permitted only in or among

305

countries not thus excluded. In such case, this License incorporates

306

the limitation as if written in the body of this License.

307

308

9. The Free Software Foundation may publish revised and/or new versions

309

of the General Public License from time to time. Such new versions will

310

be similar in spirit to the present version, but may differ in detail to

311

address new problems or concerns.

312

313

Each version is given a distinguishing version number. If the Program

314

specifies a version number of this License which applies to it and "any

315

later version", you have the option of following the terms and conditions

316

either of that version or of any later version published by the Free

317

Software Foundation. If the Program does not specify a version number of

318

this License, you may choose any version ever published by the Free Software

319

Foundation.

320

321

10. If you wish to incorporate parts of the Program into other free

322

programs whose distribution conditions are different, write to the author

323

to ask for permission. For software which is copyrighted by the Free

324

Software Foundation, write to the Free Software Foundation; we sometimes

325

make exceptions for this. Our decision will be guided by the two goals

326

of preserving the free status of all derivatives of our free software and

327

of promoting the sharing and reuse of software generally.

328

329

NO WARRANTY

330

331

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY

332

FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN

333

OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES

334

PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED

335

OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

336

MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS

337

TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE

338

PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,

339

REPAIR OR CORRECTION.

340

341

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING

342

WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR

343

REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,

344

INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING

345

OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED

346

TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY

347

YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER

348

PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE

349

POSSIBILITY OF SUCH DAMAGES.

350

351

END OF TERMS AND CONDITIONS

352

353

How to Apply These Terms to Your New Programs

354

355

If you develop a new program, and you want it to be of the greatest

356

possible use to the public, the best way to achieve this is to make it

357

free software which everyone can redistribute and change under these terms.

358

359

To do so, attach the following notices to the program. It is safest

360

to attach them to the start of each source file to most effectively

361

convey the exclusion of warranty; and each file should have at least

362

the "copyright" line and a pointer to where the full notice is found.

363

364

365

Copyright (C) <year> <name of author>

366

367

This program is free software; you can redistribute it and/or modify

368

it under the terms of the GNU General Public License as published by

369

the Free Software Foundation; either version 2 of the License, or

370

(at your option) any later version.

371

372

This program is distributed in the hope that it will be useful,

373

but WITHOUT ANY WARRANTY; without even the implied warranty of

374

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

375

GNU General Public License for more details.

376

377

You should have received a copy of the GNU General Public License along

378

with this program; if not, write to the Free Software Foundation, Inc.,

379

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

380

381

Also add information on how to contact you by electronic and paper mail.

382

383

If the program is interactive, make it output a short notice like this

384

when it starts in an interactive mode:

385

386

Gnomovision version 69, Copyright (C) year name of author

387

Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.

388

This is free software, and you are welcome to redistribute it

389

under certain conditions; type `show c' for details.

390

391

The hypothetical commands `show w' and `show c' should show the appropriate

392

parts of the General Public License. Of course, the commands you use may

393

be called something other than `show w' and `show c'; they could even be

394

mouse-clicks or menu items--whatever suits your program.

395

396

You should also get your employer (if you work as a programmer) or your

397

school, if any, to sign a "copyright disclaimer" for the program, if

398

necessary. Here is a sample; alter the names:

399

400

Yoyodyne, Inc., hereby disclaims all copyright interest in the program

401

`Gnomovision' (which makes passes at compilers) written by James Hacker.

402

403

<signature of Ty Coon>, 1 April 1989

404

Ty Coon, President of Vice

405

406

This General Public License does not permit incorporating your program into

407

proprietary programs. If your program is a subroutine library, you may

408

consider it more useful to permit linking proprietary applications with the

409

library. If this is what you want to do, use the GNU Lesser General

410

Public License instead of this License.

411

"""

412

413

def main(argv=None):

414

parser = OptionParser()

415

parser.add_option("-p", "--package", dest="package_name", action="store",

416

help="Name of the package that this is documenting")

417

parser.add_option("-v", "--version", action="store", dest="version",

418

help="Package version (datestamp, such as 20081125")

419

parser.add_option("-i", "--input", action="store", dest="source",

420

help="Directory of source documentation")

421

parser.add_option("-o", "--output", action="store", dest="output",

422

help="Directory where the finished package should be placed")

423

parser.add_option("-l", "--license", action="store", dest="license",

424

help="Under what the docs are under. GPLv2 default")

425

parser.add_option("-m", "--maintainer", action="store", dest="maintainer",

426

help="Who we blame when things don't work, \"in First"+

427

" Last <foo@bar.com>\" style")

428

parser.add_option("--moo", action="store", dest="moo",

429

help="This script has super COW powers")

430

431

(options, args) = parser.parse_args()

432

final_rules = RULES_EXAMPLE.replace("$PACKAGE", options.package_name)

433

final_control = CONTROL_EXAMPLE.replace("$PACKAGE", options.package_name)

434

final_control = final_control.replace("MAINTAINER", options.maintainer)

435

436

os.makedirs(options.output + "/debian")

437

f = open(options.output + "/debian/rules", "w")

438

f.writelines(final_rules)

439

f.close()

440

441

f = open(options.output + "/debian/control", "w")

442

f.writelines(final_control)

443

f.close()

444

445

f = open(options.output + "/debian/copyright", "w")

446

if not license:

447

f.writelines(GPLv2)

448

f.close()

449

450

f = open(options.output + "/debian/README.debian", "w")

451

f.writelines(README_DEBIAN_EXAMPLE)

452

f.close()

453

454

os.rename(options.source, options.output + "/docs")

455

456

os.chdir(options.output)

457

call(["dch", "--create", "-v", options.version, "--package", options.package_name + "-docs"])

458

459

460

461

462

if __name__ == "__main__":

463

sys.exit(main())

b'\\ No newline at end of file'