bin/lesson_initialize.py

   1 #!/usr/bin/env python
   2
   3 """Initialize a newly-created repository."""
   4
   5
   6 from __future__ import print_function
   7 import sys
   8 import os
   9
  10 ROOT_AUTHORS = '''\
  11 FIXME: list authors' names and email addresses.
  12 '''
  13
  14 ROOT_CITATION = '''\
  15 FIXME: describe how to cite this lesson.
  16 '''
  17
  18 ROOT_CONTRIBUTING_MD = '''\
  19 # Contributing
  20
  21 [Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
  22 and we welcome contributions of all kinds:
  23 new lessons,
  24 fixes to existing material,
  25 bug reports,
  26 and reviews of proposed changes are all welcome.
  27
  28 ## Contributor Agreement
  29
  30 By contributing,
  31 you agree that we may redistribute your work under [our license](LICENSE.md).
  32 In exchange,
  33 we will address your issues and/or assess your change proposal as promptly as we can,
  34 and help you become a member of our community.
  35 Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
  36 agrees to abide by our [code of conduct](CONDUCT.md).
  37
  38 ## How to Contribute
  39
  40 The easiest way to get started is to file an issue
  41 to tell us about a spelling mistake,
  42 some awkward wording,
  43 or a factual error.
  44 This is a good way to introduce yourself
  45 and to meet some of our community members.
  46
  47 1.  If you do not have a [GitHub][github] account,
  48     you can [send us comments by email][email].
  49     However,
  50     we will be able to respond more quickly if you use one of the other methods described below.
  51
  52 2.  If you have a [GitHub][github] account,
  53     or are willing to [create one][github-join],
  54     but do not know how to use Git,
  55     you can report problems or suggest improvements by [creating an issue][issues].
  56     This allows us to assign the item to someone
  57     and to respond to it in a threaded discussion.
  58
  59 3.  If you are comfortable with Git,
  60     and would like to add or change material,
  61     you can submit a pull request (PR).
  62     Instructions for doing this are [included below](#using-github).
  63
  64 ## Where to Contribute
  65
  66 1.  If you wish to change this lesson,
  67     please work in <https://github.com/swcarpentry/FIXME>,
  68     which can be viewed at <https://swcarpentry.github.io/FIXME>.
  69
  70 2.  If you wish to change the example lesson,
  71     please work in <https://github.com/swcarpentry/lesson-example>,
  72     which documents the format of our lessons
  73     and can be viewed at <https://swcarpentry.github.io/lesson-example>.
  74
  75 3.  If you wish to change the template used for workshop websites,
  76     please work in <https://github.com/swcarpentry/workshop-template>.
  77     The home page of that repository explains how to set up workshop websites,
  78     while the extra pages in <https://swcarpentry.github.io/workshop-template>
  79     provide more background on our design choices.
  80
  81 4.  If you wish to change CSS style files, tools,
  82     or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
  83     please work in <https://github.com/swcarpentry/styles>.
  84
  85 ## What to Contribute
  86
  87 There are many ways to contribute,
  88 from writing new exercises and improving existing ones
  89 to updating or filling in the documentation
  90 and and submitting [bug reports][issues]
  91 about things that don't work, aren't clear, or are missing.
  92 If you are looking for ideas,
  93 please see [the list of issues for this repository][issues],
  94 or the issues for [Data Carpentry][dc-issues]
  95 and [Software Carpentry][swc-issues] projects.
  96
  97 Comments on issues and reviews of pull requests are just as welcome:
  98 we are smarter together than we are on our own.
  99 Reviews from novices and newcomers are particularly valuable:
 100 it's easy for people who have been using these lessons for a while
 101 to forget how impenetrable some of this material can be,
 102 so fresh eyes are always welcome.
 103
 104 ## What *Not* to Contribute
 105
 106 Our lessons already contain more material than we can cover in a typical workshop,
 107 so we are usually *not* looking for more concepts or tools to add to them.
 108 As a rule,
 109 if you want to introduce a new idea,
 110 you must (a) estimate how long it will take to teach
 111 and (b) explain what you would take out to make room for it.
 112 The first encourages contributors to be honest about requirements;
 113 the second, to think hard about priorities.
 114
 115 We are also not looking for exercises or other material that only run on one platform.
 116 Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
 117 in order to be usable,
 118 our lessons must run equally well on all three.
 119
 120 ## Using GitHub
 121
 122 If you choose to contribute via GitHub,
 123 you may want to look at
 124 [How to Contribute to an Open Source Project on GitHub][how-contribute].
 125 In brief:
 126
 127 1.  The published copy of the lesson is in the `gh-pages` branch of the repository
 128     (so that GitHub will regenerate it automatically).
 129     Please create all branches from that,
 130     and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
 131     before starting work.
 132     Please do *not* work directly in your `gh-pages` branch,
 133     since that will make it difficult for you to work on other contributions.
 134
 135 2.  We use [GitHub flow][github-flow] to manage changes:
 136     1.  Create a new branch in your desktop copy of this repository for each significant change.
 137     2.  Commit the change in that branch.
 138     3.  Push that branch to your fork of this repository on GitHub.
 139     4.  Submit a pull request from that branch to the [master repository][repo].
 140     5.  If you receive feedback,
 141         make changes on your desktop and push to your branch on GitHub:
 142         the pull request will update automatically.
 143
 144 Each lesson has two maintainers who review issues and pull requests
 145 or encourage others to do so.
 146 The maintainers are community volunteers,
 147 and have final say over what gets merged into the lesson.
 148
 149 ## Other Resources
 150
 151 General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
 152 happens on the [discussion mailing list][discuss-list],
 153 which everyone is welcome to join.
 154 You can also [reach us by email][email].
 155
 156 [email]: mailto:admin@software-carpentry.org
 157 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
 158 [dc-lessons]: http://datacarpentry.org/lessons/
 159 [dc-site]: http://datacarpentry.org/
 160 [discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
 161 [github]: https://github.com
 162 [github-flow]: https://guides.github.com/introduction/flow/
 163 [github-join]: https://github.com/join
 164 [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
 165 [issues]: https://github.com/swcarpentry/FIXME/issues/
 166 [repo]: https://github.com/swcarpentry/FIXME/
 167 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
 168 [swc-lessons]: https://software-carpentry.org/lessons/
 169 [swc-site]: https://software-carpentry.org/
 170 '''
 171
 172 ROOT_CONFIG_YML = '''\
 173 #------------------------------------------------------------
 174 # Values for this lesson.
 175 #------------------------------------------------------------
 176
 177 # Which carpentry is this ("swc", "dc", or "lc")?
 178 carpentry: "swc"
 179
 180 # Overall title for pages.
 181 title: "Lesson Title"
 182
 183 # Contact.  This *must* include the protocol: if it's an email
 184 # address, it must look like "mailto:lessons@software-carpentry.org",
 185 # or if it's a URL, "https://gitter.im/username/ProjectName".
 186 email: "mailto:lessons@software-carpentry.org"
 187
 188 #------------------------------------------------------------
 189 # Generic settings (should not need to change).
 190 #------------------------------------------------------------
 191
 192 # What kind of thing is this ("workshop" or "lesson")?
 193 kind: "lesson"
 194
 195 # Magic to make URLs resolve both locally and on GitHub.
 196 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
 197 repository: <USERNAME>/<PROJECT>
 198
 199 # Sites.
 200 amy_site: "https://amy.software-carpentry.org/workshops"
 201 dc_site: "http://datacarpentry.org"
 202 swc_github: "https://github.com/swcarpentry"
 203 swc_site: "https://software-carpentry.org"
 204 swc_pages: "https://swcarpentry.github.io"
 205 lc_site: "https://librarycarpentry.github.io/"
 206 template_repo: "https://github.com/swcarpentry/styles"
 207 example_repo: "https://github.com/swcarpentry/lesson-example"
 208 example_site: "https://swcarpentry.github.com/lesson-example"
 209 workshop_repo: "https://github.com/swcarpentry/workshop-template"
 210 workshop_site: "https://swcarpentry.github.io/workshop-template"
 211 training_site: "https://swcarpentry.github.io/instructor-training"
 212
 213 # Surveys.
 214 pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
 215 post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
 216 training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
 217
 218 # Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
 219 start_time: 0
 220
 221 # Specify that things in the episodes collection should be output.
 222 collections:
 223   episodes:
 224     output: true
 225     permalink: /:path/index.html
 226   extras:
 227     output: true
 228     permalink: /:path/index.html
 229
 230 # Set the default layout for things in the episodes collection.
 231 defaults:
 232   - values:
 233       root: ..
 234   - scope:
 235       path: ""
 236       type: episodes
 237     values:
 238       layout: episode
 239
 240 # Files and directories that are not to be copied.
 241 exclude:
 242   - Makefile
 243   - bin
 244
 245 # Turn on built-in syntax highlighting.
 246 highlighter: rouge
 247 '''
 248
 249 ROOT_INDEX_MD = '''\
 250 ---
 251 layout: lesson
 252 root: .
 253 permalink: index.html  # Is the only page that don't follow the partner /:path/index.html
 254 ---
 255 FIXME: home page introduction
 256
 257 > ## Prerequisites
 258 >
 259 > FIXME
 260 {: .prereq}
 261 '''
 262
 263 ROOT_REFERENCE_MD = '''\
 264 ---
 265 layout: reference
 266 root: .
 267 ---
 268
 269 ## Glossary
 270
 271 FIXME
 272 '''
 273
 274 ROOT_SETUP_MD = '''\
 275 ---
 276 layout: page
 277 title: Setup
 278 root: .
 279 ---
 280 FIXME
 281 '''
 282
 283 ROOT_AIO_MD = '''\
 284 ---
 285 layout: page
 286 root: .
 287 ---
 288 <script>
 289   window.onload = function() {
 290     var lesson_episodes = [
 291     {% for episode in site.episodes %}
 292     "{{ episode.url}}"{% unless forloop.last %},{% endunless %}
 293     {% endfor %}
 294     ];
 295     var xmlHttp = [];  /* Required since we are going to query every episode. */
 296     for (i=0; i < lesson_episodes.length; i++) {
 297       xmlHttp[i] = new XMLHttpRequest();
 298       xmlHttp[i].episode = lesson_episodes[i];  /* To enable use this later. */
 299       xmlHttp[i].onreadystatechange = function() {
 300       if (this.readyState == 4 && this.status == 200) {
 301         var article_here = document.getElementById(this.episode);
 302         var parser = new DOMParser();
 303         var htmlDoc = parser.parseFromString(this.responseText,"text/html");
 304         var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
 305         article_here.innerHTML = htmlDocArticle.innerHTML;
 306         }
 307       }
 308       episode_url = "{{ page.root }}" + lesson_episodes[i];
 309       xmlHttp[i].open("GET", episode_url);
 310       xmlHttp[i].send(null);
 311     }
 312   }
 313 </script>
 314 {% comment %}
 315 Create anchor for each one of the episodes.
 316 {% endcomment %}
 317 {% for episode in site.episodes %}
 318 <article id="{{ episode.url }}"></article>
 319 {% endfor %}
 320 '''
 321
 322 EPISODES_INTRODUCTION_MD = '''\
 323 ---
 324 title: "Introduction"
 325 teaching: 0
 326 exercises: 0
 327 questions:
 328 - "Key question"
 329 objectives:
 330 - "First objective."
 331 keypoints:
 332 - "First key point."
 333 ---
 334 '''
 335
 336 EXTRAS_ABOUT_MD = '''\
 337 ---
 338 layout: page
 339 title: About
 340 ---
 341 {% include carpentries.html %}
 342 '''
 343
 344 EXTRAS_DISCUSS_MD = '''\
 345 ---
 346 layout: page
 347 title: Discussion
 348 ---
 349 FIXME
 350 '''
 351
 352 EXTRAS_FIGURES_MD = '''\
 353 ---
 354 layout: page
 355 title: Figures
 356 ---
 357 <script>
 358   window.onload = function() {
 359     var lesson_episodes = [
 360     {% for episode in site.episodes %}
 361     "{{ episode.url}}"{% unless forloop.last %},{% endunless %}
 362     {% endfor %}
 363     ];
 364     var xmlHttp = [];  /* Required since we are going to query every episode. */
 365     for (i=0; i < lesson_episodes.length; i++) {
 366       xmlHttp[i] = new XMLHttpRequest();
 367       xmlHttp[i].episode = lesson_episodes[i];  /* To enable use this later. */
 368       xmlHttp[i].onreadystatechange = function() {
 369         if (this.readyState == 4 && this.status == 200) {
 370           var article_here = document.getElementById(this.episode);
 371           var parser = new DOMParser();
 372           var htmlDoc = parser.parseFromString(this.responseText,"text/html");
 373           var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
 374           article_here.appendChild(htmlDocArticle.getElementsByTagName("h1")[0]);
 375           for (let image of htmlDocArticle.getElementsByTagName("img")) {
 376             article_here.appendChild(image);
 377           }
 378         }
 379       }
 380       episode_url = "{{ page.root }}" + lesson_episodes[i];
 381       xmlHttp[i].open("GET", episode_url);
 382       xmlHttp[i].send(null);
 383     }
 384   }
 385 </script>
 386 {% comment %}
 387 Create anchor for each one of the episodes.
 388 {% endcomment %}
 389 {% for episode in site.episodes %}
 390 <article id="{{ episode.url }}"></article>
 391 {% endfor %}
 392 '''
 393
 394 EXTRAS_GUIDE_MD = '''\
 395 ---
 396 layout: page
 397 title: "Instructor Notes"
 398 ---
 399 FIXME
 400 '''
 401
 402 BOILERPLATE = (
 403     ('AUTHORS', ROOT_AUTHORS),
 404     ('CITATION', ROOT_CITATION),
 405     ('CONTRIBUTING.md', ROOT_CONTRIBUTING_MD),
 406     ('_config.yml', ROOT_CONFIG_YML),
 407     ('index.md', ROOT_INDEX_MD),
 408     ('reference.md', ROOT_REFERENCE_MD),
 409     ('setup.md', ROOT_SETUP_MD),
 410     ('aio.md', ROOT_AIO_MD),
 411     ('_episodes/01-introduction.md', EPISODES_INTRODUCTION_MD),
 412     ('_extras/about.md', EXTRAS_ABOUT_MD),
 413     ('_extras/discuss.md', EXTRAS_DISCUSS_MD),
 414     ('_extras/figures.md', EXTRAS_FIGURES_MD),
 415     ('_extras/guide.md', EXTRAS_GUIDE_MD),
 416 )
 417
 418
 419 def main():
 420     """Check for collisions, then create."""
 421
 422     # Check.
 423     errors = False
 424     for (path, _) in BOILERPLATE:
 425         if os.path.exists(path):
 426             print('Warning: {0} already exists.'.format(path), file=sys.stderr)
 427             errors = True
 428     if errors:
 429         print('**Exiting without creating files.**', file=sys.stderr)
 430         sys.exit(1)
 431
 432     # Create.
 433     for (path, content) in BOILERPLATE:
 434         with open(path, 'w') as writer:
 435             writer.write(content)
 436
 437
 438 if __name__ == '__main__':
 439     main()