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][contact].
  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][contact].
 155
 156 [contact]: 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 [example-site]: https://swcarpentry.github.io/lesson-example/
 162 [github]: http://github.com
 163 [github-flow]: https://guides.github.com/introduction/flow/
 164 [github-join]: https://github.com/join
 165 [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
 166 [issues]: https://github.com/swcarpentry/FIXME/issues/
 167 [repo]: https://github.com/swcarpentry/FIXME/
 168 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
 169 [swc-lessons]: http://software-carpentry.org/lessons/
 170 [swc-site]: http://software-carpentry.org/
 171 '''
 172
 173 ROOT_CONFIG_YML = '''\
 174 #------------------------------------------------------------
 175 # Values for this lesson.
 176 #------------------------------------------------------------
 177
 178 # Which carpentry is this ("swc" or "dc")?
 179 carpentry: "swc"
 180
 181 # Overall title for pages.
 182 title: "Lesson Title"
 183
 184 # Contact email address.
 185 email: lessons@software-carpentry.org
 186
 187 #------------------------------------------------------------
 188 # Generic settings (should not need to change).
 189 #------------------------------------------------------------
 190
 191 # What kind of thing is this ("workshop" or "lesson")?
 192 kind: "lesson"
 193
 194 # Magic to make URLs resolve both locally and on GitHub.
 195 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
 196 repository: <USERNAME>/<PROJECT>
 197
 198 # Sites.
 199 amy_site: "https://amy.software-carpentry.org/workshops"
 200 dc_site: "https://datacarpentry.org"
 201 swc_github: "https://github.com/swcarpentry"
 202 swc_site: "https://software-carpentry.org"
 203 template_repo: "https://github.com/swcarpentry/styles"
 204 example_repo: "https://github.com/swcarpentry/lesson-example"
 205 example_site: "https://swcarpentry.github.com/lesson-example"
 206 workshop_repo: "https://github.com/swcarpentry/workshop-template"
 207 workshop_site: "https://swcarpentry.github.io/workshop-template"
 208
 209 # Surveys.
 210 pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
 211 post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
 212
 213 # Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
 214 start_time: 0
 215
 216 # Specify that things in the episodes collection should be output.
 217 collections:
 218   episodes:
 219     output: true
 220     permalink: /:path/
 221   extras:
 222     output: true
 223
 224 # Set the default layout for things in the episodes collection.
 225 defaults:
 226   - scope:
 227       path: ""
 228       type: episodes
 229     values:
 230       layout: episode
 231
 232 # Files and directories that are not to be copied.
 233 exclude:
 234   - Makefile
 235   - bin
 236
 237 # Turn off built-in syntax highlighting.
 238 highlighter: false
 239 '''
 240
 241 ROOT_INDEX_MD = '''\
 242 ---
 243 layout: lesson
 244 ---
 245 FIXME: home page introduction
 246
 247 > ## Prerequisites
 248 >
 249 > FIXME
 250 {: .prereq}
 251 '''
 252
 253 ROOT_REFERENCE_MD = '''\
 254 ---
 255 layout: reference
 256 permalink: /reference/
 257 ---
 258
 259 ## Glossary
 260
 261 FIXME
 262 '''
 263
 264 ROOT_SETUP_MD = '''\
 265 ---
 266 layout: page
 267 title: Setup
 268 permalink: /setup/
 269 ---
 270 FIXME
 271 '''
 272
 273 EPISODES_INTRODUCTION_MD = '''\
 274 ---
 275 title: "Introduction"
 276 teaching: 0
 277 exercises: 0
 278 questions:
 279 - "Key question"
 280 objectives:
 281 - "First objective."
 282 keypoints:
 283 - "First key point."
 284 ---
 285 '''
 286
 287 EXTRAS_ABOUT_MD = '''\
 288 ---
 289 layout: page
 290 title: About
 291 permalink: /about/
 292 ---
 293 {% include carpentries.html %}
 294 '''
 295
 296 EXTRAS_DISCUSS_MD = '''\
 297 ---
 298 layout: page
 299 title: Discussion
 300 permalink: /discuss/
 301 ---
 302 FIXME
 303 '''
 304
 305 EXTRAS_FIGURES_MD = '''\
 306 ---
 307 layout: page
 308 title: Figures
 309 permalink: /figures/
 310 ---
 311 {% include all_figures.html %}
 312 '''
 313
 314 EXTRAS_GUIDE_MD = '''\
 315 ---
 316 layout: page
 317 title: "Instructors' Guide"
 318 permalink: /guide/
 319 ---
 320 FIXME
 321 '''
 322
 323 INCLUDES_ALL_FIGURES_HTML = '''\
 324 <!-- empty -->
 325 '''
 326
 327 BOILERPLATE = (
 328     ('AUTHORS', ROOT_AUTHORS),
 329     ('CITATION', ROOT_CITATION),
 330     ('CONTRIBUTING.md', ROOT_CONTRIBUTING_MD),
 331     ('_config.yml', ROOT_CONFIG_YML),
 332     ('index.md', ROOT_INDEX_MD),
 333     ('reference.md', ROOT_REFERENCE_MD),
 334     ('setup.md', ROOT_SETUP_MD),
 335     ('_episodes/01-introduction.md', EPISODES_INTRODUCTION_MD),
 336     ('_extras/about.md', EXTRAS_ABOUT_MD),
 337     ('_extras/discuss.md', EXTRAS_DISCUSS_MD),
 338     ('_extras/figures.md', EXTRAS_FIGURES_MD),
 339     ('_extras/guide.md', EXTRAS_GUIDE_MD),
 340     ('_includes/all_figures.html', INCLUDES_ALL_FIGURES_HTML)
 341 )
 342
 343
 344 def main():
 345     """Check for collisions, then create."""
 346
 347     # Check.
 348     errors = False
 349     for (path, _) in BOILERPLATE:
 350         if os.path.exists(path):
 351             print('Warning: {0} already exists.'.format(path), file=sys.stderr)
 352             errors = True
 353     if errors:
 354         print('**Exiting without creating files.**', file=sys.stderr)
 355         sys.exit(1)
 356
 357     # Create.
 358     for (path, content) in BOILERPLATE:
 359         with open(path, 'w') as writer:
 360             writer.write(content)
 361
 362
 363 if __name__ == '__main__':
 364     main()