{"id":19887973,"url":"https://github.com/i2mint/epythet","last_synced_at":"2025-10-12T15:41:23.960Z","repository":{"id":46834008,"uuid":"289395819","full_name":"i2mint/epythet","owner":"i2mint","description":"Tools for documentation","archived":false,"fork":false,"pushed_at":"2025-08-22T20:12:38.000Z","size":6902,"stargazers_count":1,"open_issues_count":9,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-22T22:47:42.806Z","etag":null,"topics":["docstring","documentation","documentation-generator","documentation-tool","github-actions","github-page","python","python-3","python3","restructuredtext","rst","sphinx-doc","sphinx-documentation"],"latest_commit_sha":null,"homepage":"https://i2mint.github.io/epythet/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/i2mint.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2020-08-22T01:15:58.000Z","updated_at":"2025-08-22T20:12:01.000Z","dependencies_parsed_at":"2024-11-12T13:31:52.655Z","dependency_job_id":"f35e7339-1ba2-45a8-8169-dede31fc59cf","html_url":"https://github.com/i2mint/epythet","commit_stats":{"total_commits":195,"total_committers":10,"mean_commits":19.5,"dds":0.7282051282051283,"last_synced_commit":"a80bb70e8e4815ca349b686123810e8014ef7f25"},"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"purl":"pkg:github/i2mint/epythet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i2mint%2Fepythet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i2mint%2Fepythet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i2mint%2Fepythet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i2mint%2Fepythet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/i2mint","download_url":"https://codeload.github.com/i2mint/epythet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/i2mint%2Fepythet/sbom","scorecard":{"id":476211,"data":{"date":"2025-08-11","repo":{"name":"github.com/i2mint/epythet","commit":"ac8f7d64e56b658b4e8892995ca2ab4e806e6e89"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","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":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"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":"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/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/i2mint/epythet/ci.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  11 third-party GitHubAction 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":"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":"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: Apache License 2.0: 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":"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":"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"}}]},"last_synced_at":"2025-08-19T15:22:36.040Z","repository_id":46834008,"created_at":"2025-08-19T15:22:36.040Z","updated_at":"2025-08-19T15:22:36.040Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279011855,"owners_count":26085005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["docstring","documentation","documentation-generator","documentation-tool","github-actions","github-page","python","python-3","python3","restructuredtext","rst","sphinx-doc","sphinx-documentation"],"created_at":"2024-11-12T18:05:52.538Z","updated_at":"2025-10-12T15:41:23.914Z","avatar_url":"https://github.com/i2mint.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# epythet\n\nDocumentation and packaging tools.\nLess humdrum, more automation, earlier at the pub.\n\n[Full documentation here](https://i2mint.github.io/epythet/index.html) generated by Epythet.\n\n# Getting Started\nFollow the [Sphinx Installation Guide](https://www.sphinx-doc.org/en/master/usage/installation.html)\n\n```\npip install epythet\n```\nFollow the short [Quickstart Guide](https://i2mint.github.io/epythet/module_docs/epythet.html#quickstart)\n\n# About\nTired of learning new frameworks and just need something to quickly display your docstrings in your python files? You've come to the right place. Epythet is built on\n [Sphinx Python Documentation Generator](https://www.sphinx-doc.org/en/master/index.html) but automatically generates pages for each module .py files and a table of contents.\n\n\n# Publishing to GitHub Page with GitHub Actions\nAdd workflow [.github/workflows/publish-docs.yml](https://github.com/i2mint/epythet/blob/master/.github/workflows/publish-docs.yml) to your repo and modify the trigger conditions to suit your needs.  Example below will run automatically when the other \"Continuous Integration\" workflow is completed.\n```\nname: GitHub Pages\n\non:\n  workflow_run:\n    workflows: [\"Continuous Integration\"]\n    types:\n      - completed\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: i2mint/epythet/actions/publish-github-pages@master\n        with:\n          github-token: ${{ secrets.GITHUB_TOKEN }}\n          docs-branch: \"gh-pages\"\n          docs-dir: \"./docsrc/_build/html/\"\n          python-version: \"3.10\"\n```\nSetup the GitHub Pages for your repo after the target docs-branch is created.  Set the target branch (default: \"gh-pages\") and folder as `/(root)`\n![image](https://user-images.githubusercontent.com/22692594/212193474-80b287e2-211c-470d-aa7c-9f779bdd3866.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fi2mint%2Fepythet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fi2mint%2Fepythet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fi2mint%2Fepythet/lists"}