Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/coderefinery/modular-type-along

Modular code development - Making reusing parts of your code easier

https://github.com/coderefinery/modular-type-along

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.4%) to scientific vocabulary

Keywords

demo modular-design
Last synced: 6 months ago · JSON representation ·

Repository

Modular code development - Making reusing parts of your code easier

Basic Info
Statistics
  • Stars: 3
  • Watchers: 3
  • Forks: 8
  • Open Issues: 5
  • Releases: 1
Topics
demo modular-design
Created about 6 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Modular code development - Making reusing parts of your code easier

Type-along/demo where we discuss and experience aspects of (un)modular code development. It is an interactive demo with an intro, and then instructors start with the basic code in a Jupyter notebook and build up to something approaching a reusable command line script. It's usually done live, with the audience suggesting what comes next (not following the given solution exactly).

Adding more languages as examples

We welcome people to add more exercises as examples. What to do:

  • If you don't know of the lesson already, watch one of the videos and/or read it in detail.

  • Find the example in the solution page, content/solution.md. Copy the {group-tab} for an existing language, copy it to below, and modify it for your new language.

  • Add new files in content/code/LANGUAGE/ and link them with the literalinclude. Try to use the same base filename.

  • Please don't submit pure AI generated code. These are examples to humans to understand certain concepts, not just to get something done.

  • Send a pull request. Don't worry if all the syntax is perfect or not, we can fix it and make it consistent, just focus on your language (or you could put just the language code in an issue and we'll do all the rest ourselves).

Owner

  • Name: coderefinery
  • Login: coderefinery
  • Kind: organization
  • Email: support@coderefinery.com

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this lesson material, please cite it using these metadata."
authors:
- name: "CodeRefinery"
- family-names: "Bast"
  given-names: "Radovan"
- family-names: "Darst"
  given-names: "Richard"
- family-names:  "Juselius"
  given-names: "Jonas"
- family-names: "Di Remigio Eikås"
  given-names: "Roberto"
- family-names: "Bjørndalen"
  given-names: "Ole Martin"
- family-names: "Fouilloux"
  given-names: "Anne"
title: "Modular code development type-along"
type: "data"
abstract: "Making reusing parts of your code easier. The focus of this lesson is how to partition and organize projects as they grow from one screen-full to larger and how to make code portions reusable across projects and across notebooks."
version: 2025-02-26
date-released: 2025-02-26
url: "https://coderefinery.github.io/modular-type-along/"
license: CC-BY-4.0
repository-code: "https://github.com/coderefinery/modular-type-along"

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 3
  • Delete event: 2
  • Issue comment event: 4
  • Push event: 15
  • Pull request review comment event: 1
  • Pull request review event: 1
  • Pull request event: 3
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 3
  • Delete event: 2
  • Issue comment event: 4
  • Push event: 15
  • Pull request review comment event: 1
  • Pull request review event: 1
  • Pull request event: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 2
  • Average time to close issues: 21 days
  • Average time to close pull requests: 12 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: 21 days
  • Average time to close pull requests: 12 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • rkdarst (2)
  • samumantha (1)
Pull Request Authors
  • samumantha (1)
  • bast (1)
  • rkdarst (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

requirements.txt pypi
  • Sphinx *
  • myst_nb *
  • sphinx-lesson *
  • sphinx_rtd_theme *
  • sphinx_rtd_theme_ext_color_contrast *
.github/workflows/sphinx.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • ammaraskar/sphinx-problem-matcher master composite
  • peaceiris/actions-gh-pages v3 composite