judicious

Pedagogical documentation system for Python

https://github.com/luceresearchlab/judicious

Science Score: 26.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.9%) to scientific vocabulary

Keywords

api documentation education python
Last synced: 9 months ago · JSON representation

Repository

Pedagogical documentation system for Python

Basic Info
  • Host: GitHub
  • Owner: LuCEresearchlab
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Homepage: https://judicious.vercel.app/
  • Size: 1.61 MB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
api documentation education python
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Judicious

Judicious

Judicious is a pedagogical documentation system for Python. It offers a clear and distinctive visual representation of functions and constants; gradually presents more information such as types, optional and variable-length parameters for functions; highlights functions with side effects; and instantaneously generates documentation also for functions defined in student code.

Playground

Try Judicious in your browser at judicious.vercel.app.

Design Principles

This SPLASH-E paper provides more information on Judicious' design principles.

Development

Judicious is an open-source project built using Next.js. To run it locally, clone the repository, install the dependencies with npm install, and start the development server with npm run dev.

React components are in the components directory. The Python analyzer inside the tools/python-analyzer directory is a Rust program compiled to WebAssembly using wasm-pack. JSON files with the documentation of Python standard libraries are in public/docs.

Owner

  • Name: Luce - Lugano Computing Education Research Lab
  • Login: LuCEresearchlab
  • Kind: organization
  • Location: Lugano, Switzerland

Computer Science Education at USI

GitHub Events

Total
  • Push event: 4
Last Year
  • Push event: 4

Dependencies

tools/python-analyzer/Cargo.lock cargo
  • Inflector 0.11.4
  • aho-corasick 1.1.3
  • bitflags 2.6.0
  • bstr 1.10.0
  • bumpalo 3.16.0
  • castaway 0.2.3
  • cc 1.1.15
  • cfg-if 1.0.0
  • compact_str 0.8.0
  • console_error_panic_hook 0.1.7
  • either 1.13.0
  • getopts 0.2.21
  • getrandom 0.2.15
  • is-macro 0.3.5
  • itertools 0.13.0
  • itoa 1.0.11
  • js-sys 0.3.70
  • libc 0.2.155
  • log 0.4.22
  • memchr 2.7.4
  • minicov 0.3.5
  • once_cell 1.19.0
  • phf 0.11.2
  • phf_codegen 0.11.2
  • phf_generator 0.11.2
  • phf_shared 0.11.2
  • ppv-lite86 0.2.17
  • proc-macro2 1.0.86
  • quote 1.0.36
  • rand 0.8.5
  • rand_chacha 0.3.1
  • rand_core 0.6.4
  • regex-automata 0.4.7
  • rustc-hash 2.0.0
  • rustversion 1.0.17
  • ryu 1.0.18
  • same-file 1.0.6
  • scoped-tls 1.0.1
  • serde 1.0.204
  • serde-wasm-bindgen 0.4.5
  • serde_derive 1.0.204
  • serde_json 1.0.120
  • shlex 1.3.0
  • siphasher 0.3.11
  • static_assertions 1.1.0
  • syn 2.0.71
  • tinyvec 1.8.0
  • tinyvec_macros 0.1.1
  • unicode-ident 1.0.12
  • unicode-normalization 0.1.23
  • unicode-width 0.1.13
  • unicode_names2 1.2.2
  • unicode_names2_generator 1.2.2
  • walkdir 2.5.0
  • wasi 0.11.0+wasi-snapshot-preview1
  • wasm-bindgen 0.2.93
  • wasm-bindgen-backend 0.2.93
  • wasm-bindgen-futures 0.4.43
  • wasm-bindgen-macro 0.2.93
  • wasm-bindgen-macro-support 0.2.93
  • wasm-bindgen-shared 0.2.93
  • wasm-bindgen-test 0.3.43
  • wasm-bindgen-test-macro 0.3.43
  • web-sys 0.3.70
  • winapi-util 0.1.9
  • windows-sys 0.59.0
  • windows-targets 0.52.6
  • windows_aarch64_gnullvm 0.52.6
  • windows_aarch64_msvc 0.52.6
  • windows_i686_gnu 0.52.6
  • windows_i686_gnullvm 0.52.6
  • windows_i686_msvc 0.52.6
  • windows_x86_64_gnu 0.52.6
  • windows_x86_64_gnullvm 0.52.6
  • windows_x86_64_msvc 0.52.6
tools/python-analyzer/Cargo.toml cargo
  • wasm-bindgen-test 0.3.43 development
  • console_error_panic_hook 0.1.7
  • serde 1.0
  • serde-wasm-bindgen 0.4
  • wasm-bindgen 0.2.87
package-lock.json npm
  • 845 dependencies
package.json npm
  • @pyodide/webpack-plugin ^1.3.2 development
  • @types/file-saver ^2.0.5 development
  • @types/lodash ^4.14.194 development
  • @types/node 18.11.6 development
  • @types/react 18.0.23 development
  • @types/react-dom 18.0.7 development
  • @types/uuid ^10.0.0 development
  • @typescript-eslint/eslint-plugin ^5.42.1 development
  • @typescript-eslint/parser ^5.42.1 development
  • cross-env ^7.0.3 development
  • cypress ^13.4.0 development
  • dotenv ^16.3.1 development
  • eslint ^8.27.0 development
  • eslint-config-airbnb ^19.0.4 development
  • eslint-config-airbnb-typescript ^17.0.0 development
  • eslint-config-next ^14.0.1 development
  • eslint-config-prettier ^8.5.0 development
  • eslint-plugin-cypress ^2.13.2 development
  • eslint-plugin-import ^2.26.0 development
  • eslint-plugin-jsx-a11y ^6.6.1 development
  • eslint-plugin-react ^7.31.10 development
  • eslint-plugin-react-hooks ^4.6.0 development
  • monaco-editor ^0.50.0 development
  • prettier ^2.7.1 development
  • simple-git ^3.14.1 development
  • ts-node ^10.9.1 development
  • typescript ^5.6.3 development
  • @emotion/cache ^11.10.5
  • @emotion/react ^11.10.5
  • @emotion/server ^11.10.0
  • @emotion/styled ^11.10.5
  • @floating-ui/react ^0.26.25
  • @fontsource-variable/fira-code ^5.0.20
  • @fontsource/fira-sans ^5.0.2
  • @formatjs/intl-localematcher ^0.5.1
  • @hapi/topo ^6.0.2
  • @monaco-editor/react ^4.5.1
  • @mui/icons-material ^5.15.7
  • @mui/lab ^5.0.0-alpha.115
  • @mui/material ^5.15.7
  • @sentry/nextjs ^7.77.0
  • @tanstack/react-query ^4.28.0
  • acorn-import-assertions ^1.9.0
  • axios ^1.1.3
  • i18next ^23.6.0
  • immer ^9.0.18
  • lodash ^4.17.21
  • material-ui-confirm ^3.0.8
  • next ^14.1.0
  • next-i18next ^15.0.0
  • next-mdx-remote ^4.4.1
  • pyodide ^0.26.1
  • react ^18.2.0
  • react-dom ^18.2.0
  • react-i18next ^13.3.1
  • react-resize-detector ^11.0.1
  • sharp ^0.32.6
  • use-local-storage-state ^18.3.3
  • use-session-storage-state ^18.2.0
  • web-worker ^1.2.0
src/python-analyzer/package.json npm