Interested in Windows support?

Open
#1,584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
jupyter, python
Domain
build-system, tooling

Research direction

Start with the README's Windows-support statement and review the listed portability areas, including git hook installation, pyproject.toml, generated artifacts, nb_write, Quarto installation, and CI tests. Done means the project runs and its tests pass consistently on Windows and Unix with the newline, encoding, shell, and installation differences addressed.

Written by the indexing model from the issue text.

Description

The README says Windows is not supported. Locally I did a port with pretty minor changes to make everything fully cross-platform. Is this something you would be interested in?

Rough list of things that needed to change:

  • Gate os.chmod in git hook installation
  • Use encoding="utf-8" everywhere explicitly
  • Specify newline="\n" for generated artifacts (otherwise you will get CRLF on Windows and LF on Unix)
    • There are a lot of Path.write_text which needed to be rewritten to Path.write_bytes because your pyproject.toml lists Python 3.9 as the minimum version and newline="\n" was added in 3.10. Your CI tests from 3.10 onwards, so bumping could simplify a lot.
  • Remove reliance on shell=True in a few places (cd tmp && xxx replaced with cwd=tmp)
  • Handle quarto installation through winget on Windows
  • Minor changes to get the tests to run correctly

There are some dependencies that could use the newline parameter for writing (nb_write) and then everything would be consistent across platforms.

Dominant language
Jupyter Notebook
Stars
5.3k
Forks
514
Avg merge
2d 30m
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AnswerDotAI/nbdev

All issues in AnswerDotAI/nbdev

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.