-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.md-bak
319 lines (250 loc) · 10.6 KB
/
README.md-bak
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# Bookmanager
[](https://zenodo.org/badge/latestdoi/180580449)
[](https://pypi.python.org/pypi/cyberaide-bookmanager)
[](https://github.com/cyberaide/bookmanager/blob/master/LICENSE)
[](https://pypi.python.org/pypi/cyberaide-bookmanager)
[](https://pypi.python.org/pypi/cyberaide-bookmanager)
[](https://pypi.python.org/pypi/cyberaide-bookmanager)
[](https://travis-ci.org/cyberaide/bookmanager)
Bookmanager is a tool to create a publication from a number of sources on the
internet. It is especially useful to create customized books, lecture notes, or
handouts. Content is best integrated in markdown format as it is very fast to
produce the output. At present we only produce epubs, but it will be easy to
also create pdf, html, work, odt and others. As we use pandoc we can support the
formats supported by it.
Implemented Features:
* Table of contents with indentation levels can be specified via yaml
* Special variable substitution of elements defined in the yaml file
* Documents are fetched from github
* The documents will be inspected and the images found in them are fetched
(we assume the images are relative to the document, http links will not be modified)
* Automatic generation of a cover page
* Output is generated in a dest directory
Planed enhancements:
* integration of References via pandoc citeref
* integration of Section, Table, Image references via pandoc crossref
If you like to help get in contact with Gregor von Laszewski
```bash
$ pip install cyberaide-bookmanager
```
## Usage
```
bookmanager -- a helper to create books from markdown files in a yaml TOC.
Usage:
bookmanager version
bookmanager YAML cover
bookmanager YAML get [--format=FORMAT] [--force]
bookmanager YAML download
bookmanager YAML level
bookmanager YAML epub [--force]
bookmanager YAML pdf
bookmanager YAML html
bookmanager YAML docx
bookmanager YAML check [--format=FORMAT]
bookmanager YAML urls [--format=FORMAT]
bookmanager YAML list [--format=FORMAT] [--details]
Arguments:
YAML the yaml file
Options:
-h --help
-f, --format=FORMAT [default: markdown]
-d, --details [default: False]
Description:
In principal you only need one command at this time. All other commands are
available for test purposes.
You can create an epub with
bookmanager YAML get [--format=FORMAT]
The command searches for all images within the markdown document and fetches
them so the document can be created locally with the images. We assume all
images in the md document are for now not specified via http locations but
via relative locations.
To view the document use your favourite ePub Reader
Other commands include:
bookmanager YAML download [--format=FORMAT]
downloads the urls into the ./dest directory for local processing
bookmanager YAML check [--format=FORMAT]
checks if the urls in the yaml file exist
bookmanager YAML urls [--format=FORMAT]
lists all urls of the yaml file
bookmanager YAML list [--format=FORMAT]
lists the yaml file
Not implemented are the following features:
1) pdf: bookmanager pdf book.yml
YAML Table of Contents format:
The table of contents for the book can be controlled with a simple yaml
file that has some specific contextual enhancements. THis include the
creation of a BOOK section that has the sections outlined in hierarchical
form, and contains chapter and section headers without links that are
automatically generated.
Here is an example of a simple TOC yaml file:
* https://github.com/cyberaide/bookmanager/blob/master/tests/python.yml
Bugs and enhancement suggestions:
* https://github.com/cyberaide/bookmanager/issues
```
## Cover Page
Book manager can create a simple cover page for you.
and example is given at
* <https://github.com/cyberaide/bookmanager/blob/master/tests/example/cover.png>
## Example creation
```bash
$ git clone https://github.com/cyberaide/bookmanager.git
$ cd bookmanager
$ pip install -e .
$ bookmanager tests/python.yaml get
$ open dest/book.epub
```
## References
* Example Yamle file: <https://github.com/cyberaide/bookmanager/blob/master/tests/python.yml>
* Home page: <https://github.com/cyberaide/bookmanager>
## Requirements
Book manager requires the existence of some cloudmesh yaml files, In future releases we intend to remove them.
Simply do
```bash
$ mkdir -p ~/.cloudmesh
$ wget -P ~/.cloudmesh https://raw.githubusercontent.com/cloudmesh/cloudmesh-configuration/master/cloudmesh/configuration/etc/cloudmesh.yaml
```
In addition we require an up to date version of pandoc. Please consult with the
pandoc documentation on how to do this. Unfortunately the versions distributed
with ubuntu are outdated. On ubuntu you can say:
```bash
wget -q https://github.com/jgm/pandoc/releases/download/2.7.2/pandoc-2.7.2-1-amd64.deb
sudo dpkg -i pandoc-2.7.2-1-amd64.deb
pandoc --version
```
We recommend pandoc version 2.7.2.
## Example Yaml file
The following is an example for a table of contents yaml file that can be used
to pull together content from different repositories.
```
---
metadata:
image: "cover.png"
title: "Introduction to Python"
subtitle: "for Cloud Computing"
author: 'Gregor von Laszewski'
subauthor: "Editor"
email: "[email protected]"
url: "https://github.com/cyberaide/bookmanager"
description: "Book creator"
abstract: "my abstract"
keywords: "pandoc"
stylesheet: "epub.css"
dest: "./dest/book"
filename: "vonLaszewski-python.epub"
git:
"book": "https://raw.githubusercontent.com/cloudmesh-community/book/master/chapters"
"credit": "https://raw.githubusercontent.com/cyberaide/bookmanager/master/bookmanager/template"
BOOK:
- PREFACE:
- "{git.credit}/disclaimer.md"
- INTRODUCTION:
- "{git.book}/prg/SECTION-PYTHON.md"
- "{git.book}/prg/python/python-intro.md"
- "{git.book}/prg/python/python-install.md"
- "{git.book}/prg/python/python-interactive.md"
- "{git.book}/prg/python/python-editor.md"
- "{git.book}/prg/python/python.md"
- LIBRARIES:
- "{git.book}/prg/python/python-libraries.md"
- "{git.book}/prg/python/python-data.md"
- "{git.book}/prg/python/python-matplotlib.md"
- "{git.book}/prg/python/python-docopts.md"
- "{git.book}/prg/python/python-cmd5.md"
- "{git.book}/prg/python/python-cmd.md"
- "{git.book}/prg/python/opencv/opencv.md"
- "{git.book}/prg/python/opencv/secchi.md"
- DATA:
- "{git.book}/SECTION/SECTION-DATA.md"
- "{git.book}/data/formats.md"
- MONGO:
- "{git.book}/data/mongodb.md"
- "{git.book}/data/mongoengine.md"
- OTHER:
- "{git.book}/prg/python/python-wordcount.md"
- "{git.book}/prg/python/numpy/numpy.md"
- "{git.book}/prg/python/scipy/scipy.md"
- "{git.book}/prg/python/scikit-learn/scikit-learn.md"
- "{git.book}/prg/python/random-forest/random-forest.md"
- "{git.book}/prg/python/python-parallel.md"
- "{git.book}/prg/python/dask/dask.md"
- APPLICATIONS:
- "{git.book}/prg/python/fingerprint/fingerprint.md"
- "{git.book}/prg/python/facedetection/facedetection.md"
```
In case you have local files, you can add them with `file://`.
Let us assume you have the files all stored in a chapters directory, than
you could use the following yaml file.
```
---
metadata:
image: "cover.png"
title: "Introduction to Python"
subtitle: "for Cloud Computing"
author: 'Gregor von Laszewski'
subauthor: "Editor"
email: "[email protected]"
url: "https://github.com/cyberaide/bookmanager"
description: "Book creator"
abstract: "my abstract"
keywords: "pandoc"
stylesheet: "epub.css"
dest: "./dest/book"
filename: "vonLaszewski-python.epub"
git:
"book": "https://raw.githubusercontent.com/cloudmesh-community/book/master/chapters"
"book": "https://raw.githubusercontent.com/cloudmesh-community/book/master/chapters"
"credit": "https://raw.githubusercontent.com/cyberaide/bookmanager/master/bookmanager/template"
file:
"chapter": "file://../chapters"
BOOK:
- PREFACE:
- "{git.credit}/disclaimer.md"
- INTRODUCTION:
- "{file.chapter}/prg/SECTION-PYTHON.md"
- "{file.chapter}/prg/python/python-intro.md"
- "{file.chapter}/prg/python/python-install.md"
- "{file.chapter}/prg/python/python-interactive.md"
- "{file.chapter}/prg/python/python-editor.md"
- "{file.chapter}/prg/python/python.md"
- LIBRARIES:
- "{file.chapter}/prg/python/python-libraries.md"
- "{file.chapter}/prg/python/python-data.md"
- "{file.chapter}/prg/python/python-matplotlib.md"
- "{file.chapter}/prg/python/python-docopts.md"
- "{file.chapter}/prg/python/python-cmd5.md"
- "{file.chapter}/prg/python/python-cmd.md"
- "{file.chapter}/prg/python/opencv/opencv.md"
- "{file.chapter}/prg/python/opencv/secchi.md"
- DATA:
- "{file.chapter}/SECTION/SECTION-DATA.md"
- "{file.chapter}/data/formats.md"
- MONGO:
- "{file.chapter}/data/mongodb.md"
- "{file.chapter}/data/mongoengine.md"
- OTHER:
- "{file.chapter}/prg/python/python-wordcount.md"
- "{file.chapter}/prg/python/numpy/numpy.md"
- "{file.chapter}/prg/python/scipy/scipy.md"
- "{file.chapter}/prg/python/scikit-learn/scikit-learn.md"
- "{file.chapter}/prg/python/random-forest/random-forest.md"
- "{file.chapter}/prg/python/python-parallel.md"
- "{file.chapter}/prg/python/dask/dask.md"
- APPLICATIONS:
- "{file.chapter}/prg/python/fingerprint/fingerprint.md"
- "{file.chapter}/prg/python/facedetection/facedetection.md"
```
## Automated github links
It is possible to replace the local link that will be added to the
files with a link to a github repository. At this time this is only
supported for documents that are in the same repository.
Simply add the following in case your local files are in
`../chapter`. While specifying it in the `base`. This variable
specifies the link to the source. The variable github, will be used to
replace the base with a link to the github repository.
```
file:
"github": "https://github.com/cloudmesh-community/book/blob/master/chapters"
"base": "../chapters"
```