scodok

A simple API wrapper for ScoDoc Notes.

https://github.com/literateink/scodok

Science Score: 44.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
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.6%) to scientific vocabulary

Keywords

api grading notes scodoc typescript wrapper
Last synced: 6 months ago · JSON representation ·

Repository

A simple API wrapper for ScoDoc Notes.

Basic Info
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
api grading notes scodoc typescript wrapper
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Funding License Citation

README.md

Scodok: A simple API wrapper for ScoDoc Notes

This library *is not** affiliated with ScoDoc or SebL68/Scodoc_Notes in any way.*

Features

  • [x] Login with a ticket from CAS
  • [ ] Generate and login using a token (JWT)
  • [x] Profile picture as bytes (Vec<u8> for Rust, Uint8Array for JS/TS, ByteArray for Kotlin, ...)
  • [x] User status (UNKNOWN, STUDENT, STAFF, ADMIN, ...)
  • [ ] First authentication data (general information concerning the user and more)
  • [x] Error handling
  • [ ] More to come...

Documentation

You can find documentation with guides at docs.literate.ink/scodok.

If it's not enough you can also take a look at the examples folder in the GitHub repository for inspiration.

If none of those are helpful, you can always open an issue to ask for help or join the LiterateInk Discord server.

Owner

  • Name: LiterateInk
  • Login: LiterateInk
  • Kind: organization
  • Email: contact@literate.ink
  • Location: France

A unified school workspace for literally everyone.

Citation (CITATION.cff)

cff-version: 1.2.0
title: Scodok
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: LiterateInk
    website: "https://literate.ink"
    email: contact@literate.ink
repository-code: 'https://github.com/LiterateInk/Scodok'
url: 'https://docs.literate.ink/scodok'
abstract: >-
  A simple API wrapper for ScoDoc Notes.
keywords:
  - scodoc
  - notes
  - grading
  - wrapper
  - api
license: GPL-3.0-or-later

GitHub Events

Total
  • Release event: 1
  • Watch event: 4
  • Delete event: 1
  • Push event: 43
  • Create event: 4
Last Year
  • Release event: 1
  • Watch event: 4
  • Delete event: 1
  • Push event: 43
  • Create event: 4

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 65
  • Total Committers: 2
  • Avg Commits per committer: 32.5
  • Development Distribution Score (DDS): 0.062
Past Year
  • Commits: 65
  • Committers: 2
  • Avg Commits per committer: 32.5
  • Development Distribution Score (DDS): 0.062
Top Committers
Name Email Commits
Mikkel ALMONTE--RINGAUD v****l@g****m 61
github-actions[bot] g****] 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • npm 1 last-month
    • cargo 1,220 total
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 3
  • Total maintainers: 3
npmjs.org: scodok

A simple API wrapper for ScoDoc Notes.

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1 Last month
Rankings
Dependent repos count: 25.3%
Average: 30.9%
Dependent packages count: 36.6%
Maintainers (2)
Last synced: 6 months ago
crates.io: scodok

A simple API wrapper for ScoDoc Notes.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1,220 Total
Rankings
Dependent repos count: 23.8%
Dependent packages count: 31.6%
Average: 50.3%
Downloads: 95.4%
Maintainers (1)
Last synced: 6 months ago

Dependencies

package.json npm
  • @stylistic/eslint-plugin ^2.10.1 development
  • @types/node ^22.8.7 development
  • @typescript-eslint/parser ^8.12.2 development
  • dotenv ^16.4.5 development
  • eslint ^9.14.0 development
  • terser ^5.36.0 development
  • tsup ^8.3.5 development
  • typescript ^5.6.3 development
  • @literate.ink/utilities 1.0.0-10641118381.1
pnpm-lock.yaml npm
  • aix-ppc64@0.24.0
  • android-arm64@0.24.0
  • android-arm@0.24.0
  • android-x64@0.24.0
  • cliui@8.0.2
  • config-array@0.18.0
  • core@0.19.1
  • core@0.7.0
  • darwin-arm64@0.24.0
  • darwin-x64@0.24.0
  • eslint-plugin@2.10.1
  • eslint-utils@4.4.1
  • eslintrc@3.1.0
  • estree@1.0.6
  • freebsd-arm64@0.24.0
  • freebsd-x64@0.24.0
  • fs.scandir@2.1.5
  • fs.stat@2.0.5
  • fs.walk@1.2.8
  • gen-mapping@0.3.5
  • js@9.14.0
  • json-schema@7.0.15
  • linux-arm64@0.24.0
  • linux-arm@0.24.0
  • linux-ia32@0.24.0
  • linux-loong64@0.24.0
  • linux-mips64el@0.24.0
  • linux-ppc64@0.24.0
  • linux-riscv64@0.24.0
  • linux-s390x@0.24.0
  • linux-x64@0.24.0
  • module-importer@1.0.1
  • netbsd-x64@0.24.0
  • node@0.16.6
  • node@22.8.7
  • object-schema@2.1.4
  • openbsd-arm64@0.24.0
  • openbsd-x64@0.24.0
  • parseargs@0.11.0
  • parser@8.12.2
  • plugin-kit@0.2.2
  • regexpp@4.12.1
  • resolve-uri@3.1.2
  • retry@0.3.1
  • retry@0.4.0
  • rollup-android-arm-eabi@4.24.3
  • rollup-android-arm64@4.24.3
  • rollup-darwin-arm64@4.24.3
  • rollup-darwin-x64@4.24.3
  • rollup-freebsd-arm64@4.24.3
  • rollup-freebsd-x64@4.24.3
  • rollup-linux-arm-gnueabihf@4.24.3
  • rollup-linux-arm-musleabihf@4.24.3
  • rollup-linux-arm64-gnu@4.24.3
  • rollup-linux-arm64-musl@4.24.3
  • rollup-linux-powerpc64le-gnu@4.24.3
  • rollup-linux-riscv64-gnu@4.24.3
  • rollup-linux-s390x-gnu@4.24.3
  • rollup-linux-x64-gnu@4.24.3
  • rollup-linux-x64-musl@4.24.3
  • rollup-win32-arm64-msvc@4.24.3
  • rollup-win32-ia32-msvc@4.24.3
  • rollup-win32-x64-msvc@4.24.3
  • scope-manager@8.12.2
  • set-array@1.2.1
  • source-map@0.3.6
  • sourcemap-codec@1.5.0
  • sunos-x64@0.24.0
  • trace-mapping@0.3.25
  • types@8.12.2
  • typescript-estree@8.12.2
  • utilities@1.0.0-10641118381.1
  • utils@8.12.2
  • visitor-keys@8.12.2
  • win32-arm64@0.24.0
  • win32-ia32@0.24.0
  • win32-x64@0.24.0