{"id":26591601,"url":"https://github.com/tsvikas/nbcat","last_synced_at":"2025-03-23T14:18:46.579Z","repository":{"id":232445959,"uuid":"784373750","full_name":"tsvikas/nbcat","owner":"tsvikas","description":"display jupyter notebooks in the terminal","archived":false,"fork":false,"pushed_at":"2025-03-11T16:57:40.000Z","size":1613,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T17:50:01.464Z","etag":null,"topics":["cli","jupyter-notebooks","previewer"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","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/tsvikas.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}},"created_at":"2024-04-09T18:10:48.000Z","updated_at":"2025-03-11T16:57:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"c65784f7-7f58-4af4-a5eb-9994ffbce53a","html_url":"https://github.com/tsvikas/nbcat","commit_stats":null,"previous_names":["tsvikas/nbcat"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsvikas%2Fnbcat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsvikas%2Fnbcat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsvikas%2Fnbcat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsvikas%2Fnbcat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tsvikas","download_url":"https://codeload.github.com/tsvikas/nbcat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245111880,"owners_count":20562511,"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","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":["cli","jupyter-notebooks","previewer"],"created_at":"2025-03-23T14:18:45.951Z","updated_at":"2025-03-23T14:18:46.565Z","avatar_url":"https://github.com/tsvikas.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nbcat\n\n[![Tests][tests-badge]][tests-link]\n[![uv][uv-badge]][uv-link]\n[![Ruff][ruff-badge]][ruff-link]\n[![Black][black-badge]][black-link]\n\\\n[![Made Using tsvikas/python-template][template-badge]][template-link]\n[![GitHub Discussion][github-discussions-badge]][github-discussions-link]\n[![PRs Welcome][prs-welcome-badge]][prs-welcome-link]\n\n## Overview\n\ndisplay your notebooks, in the terminal ![Demo](assets/DEMO.gif)\n\n## Installation\n\nuse pipx to install:\n\n```bash\npipx install git+https://github.com/tsvikas/nbcat.git\n```\n\n## Usage\n\n```bash\nnbcat FILENAME -R | less -R\n```\n\nuse `-f FORMAT` to specify the output format, default is `markdown`\n\n## Development\n\n### Getting started\n\n- install [git][install-git], [uv][install-uv].\n- git clone this repo: `git clone tsvikas/nbcat.git`\n- run `uv run just prepare`\n\n### Tests and code quality\n\n- use `uv run just format` to format the code.\n- use `uv run just lint` to see linting errors.\n- use `uv run just test` to run tests.\n- use `uv run just check` to run all the checks (format, lint, test, and pre-commit).\n- Run a specific tool directly, with `uv run pytest`/`ruff`/`mypy`/`black`/...\n\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black-link]: https://github.com/psf/black\n[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions\u0026message=Ask\u0026color=blue\u0026logo=github\n[github-discussions-link]: https://github.com/tsvikas/nbcat/discussions\n[install-git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git\n[install-uv]: https://docs.astral.sh/uv/getting-started/installation/\n[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[prs-welcome-link]: http://makeapullrequest.com\n[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n[ruff-link]: https://github.com/astral-sh/ruff\n[template-badge]: https://img.shields.io/badge/%F0%9F%9A%80_Made_Using-tsvikas%2Fpython--template-gold\n[template-link]: https://github.com/tsvikas/python-template\n[tests-badge]: https://github.com/tsvikas/nbcat/actions/workflows/ci.yml/badge.svg\n[tests-link]: https://github.com/tsvikas/nbcat/actions/workflows/ci.yml\n[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json\n[uv-link]: https://github.com/astral-sh/uv\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftsvikas%2Fnbcat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftsvikas%2Fnbcat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftsvikas%2Fnbcat/lists"}