---
# System prepended metadata

title: 004 Internal

---

# 004 Internal

- 2 minute intro and HackMD
    - show hackmd
    - ask a poll "what did you learn recently that you are really excited about?"

- 3 generating a git version identifier
    - git describe HEAD
    - git describe HEAD --always

- 15 minutes rkdarst: workflows
    - About my board-game-networks project:
      https://github.com/rkdarst/board-game-networks
      why?  open data.  use git to track.  data format
    - I want to make this more automated and well-refined
    - Data management concept here
    - Overview of the project
    - Step 1: Makefiles
    - In the future we'll go over Makefiles, requirments.txt, then change to Snakemake, gh-pages, gh-actions, data-management

- 5 git difftool
    - git diff --name-only
    - Radovan shows how he double-checks staged changes
    - Radovan asks about worddiff

- 5 minutes Q&A

== halfway ==

- 5 alias for setting up Python venvs
  - Richard asks Radovan about it, because he missed it before
  - Radovan asks Richard: how do you synchronize your aliases across computers?

- 15 minutes Radovan: talking about how we document, which tools, when we choose which and why
  - different perspectives
  - in the same repo
  - MD or RST or in-source
  - From READMEs (rendered in GH and GL)
  - to generated HTML: jekyll, sphinx&readthedocs, hugo, gitbook, MkDocs, rst2html
  - pandoc to convert
  - How much is right for your project?
      - readmes
      - source code comments
      - written docs
      - api docs
  - example: https://github.com/ResearchSoftwareHour/rsh-notes/issues/13
    - overall
    - sphinx
    - sphinx-gallery
    - version tracking in multiple places
    - pypi follow-up

- 3 `units` for unit conversion

- 3 Richard asks Radovan: how do you make many small commits?

- 5 minutes Radovan
    - probably shows Cicero unless I get an inspiration

- 5 minutes Q&A
- conclusion


## Buffer or next time

- 10 minutes: what did you learn recently that you are really excited about?
  - we could ask each other and the audience
  - 2 Radovan: tells Richard about Python wheels

- 15 Intervieuw with a RSE
  - what are we going to talk about (roughly, just to place it thematically)?