bin/lesson_initialize.py

   1 #!/usr/bin/env python
   2
   3 """Initialize a newly-created repository."""
   4
   5
   6 import sys
   7 import os
   8
   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 ## What We're Looking For
  65
  66 There are many ways to contribute,
  67 from writing new exercises and improving existing ones
  68 to updating or filling in the documentation
  69 and and submitting [bug reports][issues]
  70 about things that don't work, aren't clear, or are missing.
  71 If you are looking for ideas,
  72 please see [the list of issues for this repository][issues],
  73 or the issues for [Data Carpentry][dc-issues]
  74 and [Software Carpentry][swc-issues] projects.
  75
  76 Comments on issues and reviews of pull requests are just as welcome:
  77 we are smarter together than we are on our own.
  78 Reviews from novices and newcomers are particularly valuable:
  79 it's easy for people who have been using these lessons for a while
  80 to forget how impenetrable some of this material can be,
  81 so fresh eyes are always welcome.
  82
  83 ## What We're *Not* Looking For
  84
  85 Our lessons already contain more material than we can cover in a typical workshop,
  86 so we are usually *not* looking for more concepts or tools to add to them.
  87 As a rule,
  88 if you want to introduce a new idea,
  89 you must (a) estimate how long it will take to teach
  90 and (b) explain what you would take out to make room for it.
  91 The first encourages contributors to be honest about requirements;
  92 the second, to think hard about priorities.
  93
  94 We are also not looking for exercises or other material that only run on one platform.
  95 Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
  96 in order to be usable,
  97 our lessons must run equally well on all three.
  98
  99 ## Getting Started
 100
 101 The easiest way to get started is to file an issue
 102 to tell us about a spelling mistake,
 103 some awkward wording,
 104 or a factual error.
 105 This is a good way to introduce yourself
 106 and to meet some of our community members.
 107
 108 If you want to start adding or fixing material yourself,
 109 you may want to look at
 110 [How to Contribute to an Open Source Project on GitHub][how-contribute].
 111 In brief:
 112
 113 1.  The published copy of the lesson is in the `gh-pages` branch of the repository
 114     (so that GitHub will regenerate it automatically).
 115     Please create all branches from that,
 116     and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
 117     before starting work.
 118     Please do *not* work directly in your `gh-pages` branch,
 119     since that will make it difficult for you to work on other contributions.
 120
 121 2.  We use [GitHub flow][github-flow] to manage changes:
 122     1.  Create a new branch in your desktop copy of this repository for each significant change.
 123     2.  Commit the change in that branch.
 124     3.  Push that branch to your fork of this repository on GitHub.
 125     4.  Submit a pull request from that branch to the [master repository][repo].
 126     5.  If you receive feedback,
 127         make changes on your desktop and push to your branch on GitHub:
 128         the pull request will update automatically.
 129
 130 Each lesson has two maintainers who review issues and pull requests
 131 or encourage others to do so.
 132 The maintainers are community volunteers,
 133 and have final say over what gets merged into the lesson.
 134
 135 ## Our Template
 136
 137 [This documentation][example-site] explains how we format our lessons
 138 (and is itself an example of that formatting).
 139
 140 ## Other Resources
 141
 142 General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
 143 happens on the [discussion mailing list][discuss-list],
 144 which everyone is welcome to join.
 145 You can also [reach us by email][contact].
 146
 147 [contact]: mailto:admin@software-carpentry.org
 148 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
 149 [dc-lessons]: http://datacarpentry.org/lessons/
 150 [dc-site]: http://datacarpentry.org/
 151 [discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
 152 [example-site]: https://swcarpentry.github.io/lesson-example/
 153 [github]: http://github.com
 154 [github-flow]: https://guides.github.com/introduction/flow/
 155 [github-join]: https://github.com/join
 156 [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
 157 [issues]: https://github.com/{USERNAME}/{LESSON-NAME}/issues/
 158 [repo]: https://github.com/{USERNAME}/{LESSON-NAME}/
 159 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
 160 [swc-lessons]: http://software-carpentry.org/lessons/
 161 [swc-site]: http://software-carpentry.org/
 162 '''
 163
 164 ROOT_CONFIG_YML = '''\
 165 #------------------------------------------------------------
 166 # Values for this lesson.
 167 #------------------------------------------------------------
 168
 169 # Which carpentry is this ("swc" or "dc")?
 170 carpentry: "swc"
 171
 172 # What kind of thing is this ("workshop" or "lesson")?
 173 kind: "lesson"
 174
 175 # Overall title for pages.
 176 title: "Lesson Title"
 177
 178 # Account (without slashes).
 179 account: "[[USER-NAME]]"
 180
 181 # Root URL below account (without slashes).
 182 project: "[[REPO-NAME]]"
 183
 184 # Contact email address.
 185 email: "[[CONTACT-ADDRESS]]"
 186
 187 #------------------------------------------------------------
 188 # Generic settings (should not need to change).
 189 #------------------------------------------------------------
 190
 191 # Is this production or development? (Overridden in _config_dev.yml.)
 192 is_production: true
 193
 194 # Sites.
 195 amy_site: "https://amy.software-carpentry.org/workshops"
 196 dc_site: "https://datacarpentry.org"
 197 swc_github: "https://github.com/swcarpentry"
 198 swc_site: "https://software-carpentry.org"
 199 template_repo: "https://github.com/swcarpentry/styles"
 200 example_repo: "https://github.com/swcarpentry/lesson-example"
 201 example_site: "https://swcarpentry.github.com/lesson-example"
 202 workshop_repo: "https://github.com/swcarpentry/workshop-template"
 203 workshop_site: "https://swcarpentry.github.io/workshop-template"
 204
 205 # Surveys.
 206 pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
 207 post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
 208
 209 # Start time in minutes (540 is 09:00 am)
 210 start_time: 540
 211
 212 # Specify that things in the episodes collection should be output.
 213 collections:
 214   episodes:
 215     output: true
 216     permalink: /:path/
 217   extras:
 218     output: true
 219
 220 # Set the default layout for things in the episodes collection.
 221 defaults:
 222   - scope:
 223       path: ""
 224       type: episodes
 225     values:
 226       layout: episode
 227
 228 # Files and directories that are not to be copied.
 229 exclude:
 230   - Makefile
 231   - bin
 232
 233 # Turn off built-in syntax highlighting.
 234 highlighter: false
 235 '''
 236
 237 ROOT_INDEX_MD = '''\
 238 ---
 239 layout: lesson
 240 ---
 241 FIXME: home page introduction
 242
 243 > ## Prerequisites
 244 >
 245 > FIXME
 246 {: .prereq}
 247 '''
 248
 249 ROOT_REFERENCE_MD = '''\
 250 ---
 251 layout: reference
 252 ---
 253
 254 ## Glossary
 255
 256 FIXME
 257 '''
 258
 259 ROOT_SETUP_MD = '''\
 260 ---
 261 layout: page
 262 title: Setup
 263 permalink: /setup/
 264 ---
 265 FIXME
 266 '''
 267
 268 EPISODES_INTRODUCTION_MD = '''\
 269 ---
 270 title: "Introduction"
 271 teaching: 0
 272 exercises: 0
 273 questions:
 274 - "Key question"
 275 objectives:
 276 - "First objective."
 277 keypoints:
 278 - "First key point."
 279 ---
 280 '''
 281
 282 EXTRAS_ABOUT_MD = '''\
 283 ---
 284 layout: page
 285 title: About
 286 permalink: /about/
 287 ---
 288 {% include carpentries.html %}
 289 '''
 290
 291 EXTRAS_DISCUSS_MD = '''\
 292 ---
 293 layout: page
 294 title: Discussion
 295 permalink: /discuss/
 296 ---
 297 FIXME
 298 '''
 299
 300 EXTRAS_FIGURES_MD = '''\
 301 ---
 302 layout: page
 303 title: Figures
 304 permalink: /figures/
 305 ---
 306 {% include all_figures.html %}
 307 '''
 308
 309 EXTRAS_GUIDE_MD = '''\
 310 ---
 311 layout: page
 312 title: "Instructors' Guide"
 313 permalink: /guide/
 314 ---
 315 FIXME
 316 '''
 317
 318 BOILERPLATE = (
 319     ('AUTHORS', ROOT_AUTHORS),
 320     ('CITATION', ROOT_CITATION),
 321     ('CONTRIBUTING.md', ROOT_CONTRIBUTING_MD),
 322     ('_config.yml', ROOT_CONFIG_YML),
 323     ('index.md', ROOT_INDEX_MD),
 324     ('reference.md', ROOT_REFERENCE_MD),
 325     ('setup.md', ROOT_SETUP_MD),
 326     ('_episodes/01-introduction.md', EPISODES_INTRODUCTION_MD),
 327     ('_extras/about.md', EXTRAS_ABOUT_MD),
 328     ('_extras/discuss.md', EXTRAS_DISCUSS_MD),
 329     ('_extras/figures.md', EXTRAS_FIGURES_MD),
 330     ('_extras/guide.md', EXTRAS_GUIDE_MD)
 331 )
 332
 333
 334 def main():
 335     """Check for collisions, then create."""
 336
 337     # Check.
 338     errors = False
 339     for (path, _) in BOILERPLATE:
 340         if os.path.exists(path):
 341             print('Warning: {0} already exists.'.format(path), file=sys.stderr)
 342             errors = True
 343     if errors:
 344         print('**Exiting without creating files.**', file=sys.stderr)
 345         sys.exit(1)
 346
 347     # Create.
 348     for (path, content) in BOILERPLATE:
 349         with open(path, 'w') as writer:
 350             writer.write(content)
 351
 352
 353 if __name__ == '__main__':
 354     main()