{"id":42926357,"url":"https://github.com/coderefinery/sphinx-lesson","last_synced_at":"2026-01-30T18:09:51.609Z","repository":{"id":42967329,"uuid":"264726276","full_name":"coderefinery/sphinx-lesson","owner":"coderefinery","description":"Sphinx extension for creating CodeRefinery lessons","archived":false,"fork":false,"pushed_at":"2026-01-21T20:04:42.000Z","size":8600,"stargazers_count":16,"open_issues_count":14,"forks_count":21,"subscribers_count":14,"default_branch":"master","last_synced_at":"2026-01-22T08:57:51.159Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://coderefinery.github.io/sphinx-lesson/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderefinery.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-17T18:01:22.000Z","updated_at":"2026-01-21T20:03:06.000Z","dependencies_parsed_at":"2024-01-08T15:12:36.328Z","dependency_job_id":"687cbe8b-bed8-4120-bdc8-42b8ef60ee5c","html_url":"https://github.com/coderefinery/sphinx-lesson","commit_stats":{"total_commits":195,"total_committers":8,"mean_commits":24.375,"dds":0.09230769230769231,"last_synced_commit":"2f01a884bf160ea6c3ca61596ed820f77118b375"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/coderefinery/sphinx-lesson","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-lesson","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-lesson/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-lesson/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-lesson/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderefinery","download_url":"https://codeload.github.com/coderefinery/sphinx-lesson/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-lesson/sbom","scorecard":{"id":297516,"data":{"date":"2025-08-11","repo":{"name":"github.com/coderefinery/sphinx-lesson","commit":"96ae33057d19750b39e649ecf2431b23ac9421a4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.9,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/16 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sphinx.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sphinx.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sphinx.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sphinx.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sphinx.yml:133: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sphinx.yml:151: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sphinx.yml:165: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/sphinx.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-lesson/test.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:52","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:53","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:54","Warn: pipCommand not pinned by hash: .github/workflows/sphinx.yml:50","Warn: pipCommand not pinned by hash: .github/workflows/sphinx.yml:51","Warn: pipCommand not pinned by hash: .github/workflows/sphinx.yml:104","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:33","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:39","Info:   0 out of  10 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 third-party GitHubAction dependencies pinned","Info:   0 out of   8 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/release.yml:40","Info: jobLevel 'contents' permission set to 'read': .github/workflows/sphinx.yml:29","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/sphinx.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:70"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T19:54:42.281Z","repository_id":42967329,"created_at":"2025-08-17T19:54:42.282Z","updated_at":"2025-08-17T19:54:42.282Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28917035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T16:37:38.804Z","status":"ssl_error","status_checked_at":"2026-01-30T16:37:37.878Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-30T18:09:50.991Z","updated_at":"2026-01-30T18:09:51.601Z","avatar_url":"https://github.com/coderefinery.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sphinx test lesson\n==================\n\nThis is a Sphinx extension for software-carpentry style\nlessons.  It is designed as a replacement for the Jekyll-based software\ntemplates.\n\n* `View the documentation (and example) on github pages\n  \u003chttps://coderefinery.github.io/sphinx-lesson/\u003e`__.\n* `Template repository, to copy from\n  \u003chttps://github.com/coderefinery/sphinx-lesson-template/\u003e`__.\n\n\nFeatures\n--------\n\n- Sphinx, including power from all of its extensions.\n- ReST\n- Markdown via the `myst_parser` parser, so has access to all Sphinx\n  directives natively\n- Jupyter as a source format, including executing the notebook (via\n  ``myst_nb``).\n- Automatically building via Github Actions and automatic deployment\n  to Github Pages.  Included workflow file builds all branches, so you\n  can also preview pull requests.\n- Directives for exercises/prereq/etc, works in both ReST and md.\n- The Sphinx part can be separated into a separately installable\n  and versionable Python package, so we don't need git sub-modules.\n- Execute code cells in markdown (via ``myst_nb``).\n- Consists of sub-extensions for substitutions.  Adding\n  ``sphinx_lesson`` as an extension will bring in these:\n\n  - ``sphinx_lesson.directives`` (the core directives)\n  - ``sphinx_lesson.md_transforms`` (reprocess some other markdown\n    format into myst_nb format)\n  - ``myst_nb`` (not developed by us)\n\n\n\nHost Site Locally for Development\n---------------------------------\n\n1. Create a virtual python environment::\n\n     python -m venv venv\n\n2. Activate the virtual environment::\n\n     source activate venv/bin/activate\n\n3. Install python packages::\n\n     pip install -r requirements.txt\n\n4. Build local files (this can also be used for deployment)::\n\n     make html\n     # Output in _build/html/\n     make clean html             # clean + full rebuild\n\n5. Or, start a live-compiled service for your compiled site for local development::\n\n     make livehtml\n\n   Then view created site in your browser at `http://localhost:8000 \u003chttp://localhost:8000\u003e`__ (follow the link in your console).\n\n\n\nStatus\n------\n\nIn beta use by CodeRefinery and active development.  External users\nwould be fine (but let us know so we know to keep things stable).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fsphinx-lesson","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderefinery%2Fsphinx-lesson","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fsphinx-lesson/lists"}