nbcat 0.1.0__tar.gz

nbcat-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI/CD
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Lint
+        run: make lint
+
+      - name: Test
+        run: make test
+
+      - name: Build 
+        run: make build
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-dist
+          path: dist/
+
+  deploy:
+    if: ${{ github.ref == 'refs/heads/main' && success() }}
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Download artifact from CI
+        uses: actions/download-artifact@v4
+        with:
+          name: build-dist
+          path: dist/
+
+      - name: List contents
+        run: ls -la dist/
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

nbcat-0.1.0/.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+.test_results/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

nbcat-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Akop Kesheshyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nbcat-0.1.0/Makefile

@@ -0,0 +1,45 @@
+.EXPORT_ALL_VARIABLES: ; 
+.PHONY: all
+.DEFAULT_GOAL: help
+
+UV = uv
+UVR = @$(UV) run --extra "dev"
+RUFF = $(UVR) ruff
+PYTEST = $(UVR) pytest
+
+help:
+	@echo '================================================='
+	@echo '~~ List of available commands for this project ~~'
+	@echo '================================================='
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-16s\033[0m %s\n", $$1, $$2}'
+	 
+all: format lint test ## Lint, test and build package
+
+test: ## Test package
+	$(PYTEST) -x -vv \
+		--junitxml=.test_results/test-results.xml \
+		--cov=src \
+		--cov-report=xml:.test_results/coverage.xml \
+		--cov-report=term
+
+build: ## Build package
+	@$(UV) build 
+
+start: ## Run package
+	@$(UV) pip install -e .
+	@$(UVR) nbcat
+
+deploy: build ## Publish package
+	$(UV) publish --token $(token)
+
+lint: ## Run linter over code base and auto resole minor issues
+	$(RUFF) check --fix
+
+format: ## Format the source code according to defined coding style
+	$(RUFF) format
+
+clean: ## Remove all file artifacts
+	@rm -rf .venv/ dist/ build/ *.egg-info .pytest_cache/ .coverage coverage.xml
+	@find . -type f -name "*.py[co]" -delete
+	@find . -type d -name "__pycache__" -delete
+	@find . -name '*~' -delete

nbcat-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: nbcat
+Version: 0.1.0
+Summary: cat for jupyter notebooks
+Project-URL: Homepage, https://github.com/akopdev/nbcat
+Project-URL: Repository, https://github.com/akopdev/nbcat
+Author-email: Akop Kesheshyan <devnull@akop.dev>
+Maintainer-email: Akop Kesheshyan <devnull@akop.dev>
+License: MIT License
+        
+        Copyright (c) 2025 Akop Kesheshyan
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: aiohttp
+Requires-Dist: pydantic
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: aioresponses; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# 📦 nbcat
+
+cat for jupyter notebooks
+
+[![License](https://img.shields.io/github/license/akopdev/nbcat)](./LICENSE)
+[![Build](https://github.com/akopdev/nbcat/actions/workflows/ci.yml/badge.svg)](https://github.com/akopdev/nbcat/actions)
+
+---
+
+## 🚀 Features
+
+- ✅ Clean, minimal API
+- 🧰 Easily extensible
+- 🧪 Fully tested and type-annotated
+- ⚡ Fast and lightweight
+- 📦 Available on PyPI
+
+---
+
+## 📦 Installation
+
+Install with [uv](https://github.com/astral-sh/uv)
+
+```bash
+uv pip install nbcat
+```
+
+To install the latest development version:
+
+```bash
+uv pip install git+https://github.com/akopdev/nbcat.git
+```
+
+---
+
+## 🛠️ Quickstart
+
+```python
+# example of using the package
+```
+
+For more examples, check out the [`examples/`](./examples/) folder.
+
+---
+
+## 🧪 Testing & Development
+
+Run the tests:
+
+```bash
+make test
+```
+
+Check code quality:
+
+```bash
+make lint
+```
+
+Format code:
+
+```bash
+make format
+```
+
+---
+
+## 🙌 Contributing
+
+Contributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).
+
+---
+
+## 📄 License
+
+Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
+
+---
+
+## 🔗 Useful Links
+
+- 📘 Documentation: _coming soon_
+- 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)
+- 🚀 Releases: [GitHub Releases](https://github.com/akopdev/nbcat/releases)
+
+---
+
+> Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)

nbcat-0.1.0/README.md

@@ -0,0 +1,88 @@
+# 📦 nbcat
+
+cat for jupyter notebooks
+
+[![License](https://img.shields.io/github/license/akopdev/nbcat)](./LICENSE)
+[![Build](https://github.com/akopdev/nbcat/actions/workflows/ci.yml/badge.svg)](https://github.com/akopdev/nbcat/actions)
+
+---
+
+## 🚀 Features
+
+- ✅ Clean, minimal API
+- 🧰 Easily extensible
+- 🧪 Fully tested and type-annotated
+- ⚡ Fast and lightweight
+- 📦 Available on PyPI
+
+---
+
+## 📦 Installation
+
+Install with [uv](https://github.com/astral-sh/uv)
+
+```bash
+uv pip install nbcat
+```
+
+To install the latest development version:
+
+```bash
+uv pip install git+https://github.com/akopdev/nbcat.git
+```
+
+---
+
+## 🛠️ Quickstart
+
+```python
+# example of using the package
+```
+
+For more examples, check out the [`examples/`](./examples/) folder.
+
+---
+
+## 🧪 Testing & Development
+
+Run the tests:
+
+```bash
+make test
+```
+
+Check code quality:
+
+```bash
+make lint
+```
+
+Format code:
+
+```bash
+make format
+```
+
+---
+
+## 🙌 Contributing
+
+Contributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).
+
+---
+
+## 📄 License
+
+Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
+
+---
+
+## 🔗 Useful Links
+
+- 📘 Documentation: _coming soon_
+- 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)
+- 🚀 Releases: [GitHub Releases](https://github.com/akopdev/nbcat/releases)
+
+---
+
+> Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)

nbcat-0.1.0/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "nbcat"
+version = "0.1.0"
+description = "cat for jupyter notebooks"
+authors = [
+    { name = "Akop Kesheshyan", email = "devnull@akop.dev" }
+]
+maintainers = [
+    { name = "Akop Kesheshyan", email = "devnull@akop.dev" }
+]
+license = {file = "LICENSE"}
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "aiohttp",
+    "pydantic",
+    "rich",
+]
+
+[project.optional-dependencies]
+dev = [
+    "aioresponses",
+    "ruff",
+    "pytest",
+    "pytest-asyncio",
+    "pytest-mock",
+    "pytest-cov",
+]
+
+[project.urls]
+Homepage = "https://github.com/akopdev/nbcat"
+Repository = "https://github.com/akopdev/nbcat"
+
+[project.scripts]
+nbcat = "nbcat.cli:main"
+
+[pytest]
+mock_use_standalone_module = true
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"
+testpaths = "tests/"
+
+[tool.ruff]
+exclude = [
+    ".venv",
+    "build",
+    "dist",
+    "migrations",
+    "__init__.py"
+]
+include = ["*.py", "*.pyx"]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "D"]
+ignore = [
+  "D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107"
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

nbcat-0.1.0/src/nbcat/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

nbcat-0.1.0/src/nbcat/cli.py

@@ -0,0 +1,73 @@
+import argparse
+import asyncio
+import sys
+
+from pydantic import ValidationError
+
+from . import __version__
+from .settings import Settings
+
+
+async def do_sample_command_1():
+    """Run used defined command 1."""
+
+
+async def do_sample_command_2():
+    """Run user defined command 2."""
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="cat for jupyter notebooks",
+        argument_default=argparse.SUPPRESS,
+    )
+    parser.add_argument(
+        "--list_field", help="Example of multi value list separated by comma.", type=str
+    )
+    parser.add_argument(
+        "--version",
+        help="Print version information and quite",
+        action="version",
+        version=__version__,
+    )
+
+    # Commands
+    commands = parser.add_subparsers(title="Commands", dest="command")
+
+    # Sample command 1
+    sample_command_1 = commands.add_parser(
+        "sample_command_1",
+        help="Sample command description.",
+        argument_default=argparse.SUPPRESS,
+    )
+
+    sample_command_1.set_defaults(func=do_sample_command_1)
+
+    # Sample command 2
+    sample_command_2 = commands.add_parser(
+        "sample_command_2",
+        help="Sample command description.",
+        argument_default=argparse.SUPPRESS,
+    )
+
+    sample_command_2.set_defaults(func=do_sample_command_2)
+
+    try:
+        args = parser.parse_args()
+        settings = Settings(**vars(args))
+    except ValidationError as e:
+        error = e.errors(include_url=False, include_context=False)[0]
+        sys.exit(
+            "Wrong argument value passed ({}): {}".format(
+                error.get("loc", ("system",))[0], error.get("msg")
+            )
+        )
+
+    if args.command:
+        asyncio.run(args.func(settings))
+    else:
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()

nbcat-0.1.0/src/nbcat/nbcat.py

@@ -0,0 +1,22 @@
+from datetime import datetime
+
+import aiohttp
+
+
+async def my_func(name) -> str:
+    """Get message from remote server."""
+    async with aiohttp.ClientSession() as session:
+        async with session.get("https://example.com/api.json", params={"name": name}) as response:
+            data = await response.json()
+            return data["message"]
+
+
+def now() -> datetime:
+    """Ready to mock method for date extraction."""
+    return datetime.now()
+
+
+def get_time() -> str:
+    """Return today's date."""
+    date = now()
+    return f"Today is {date.strftime('%A, %B %d, %Y')}"

nbcat-0.1.0/src/nbcat/settings.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel, model_validator
+
+
+class Settings(BaseModel):
+    """Validates cli arguments."""
+
+    field: str | None = None
+    list_field: list[str] = []
+    bool_field: bool = False
+
+    @model_validator(mode="before")
+    def parse_list_field(values: dict):
+        """You can pass multiple values as a comma separated string."""
+        if isinstance(values.get("list_field"), str):
+            values["list_field"] = values.get("list_field").split(",")
+        return values