nbcat 0.1.0__py3-none-any.whl

nbcat/__init__.py

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

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/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/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

nbcat-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,10 @@
+nbcat/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+nbcat/cli.py,sha256=BeijbCAe1J3s7UgeKW_hdRdXvkg1jo6XaT4aPGKz-Yc,1802
+nbcat/nbcat.py,sha256=eWgwOGCnOK6xQ1qC8Ku2vmQgPvA5Nx6mfdM8Ca3vU6w,580
+nbcat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nbcat/settings.py,sha256=I6sGyVidPjW_76zq9mefnS2-vzRUKL87jSPluPe_SwQ,498
+nbcat-0.1.0.dist-info/METADATA,sha256=Woo2Z2dx6A8vMsXE4k0cpYuTJ_llb1UVOqG8ENoGitE,3426
+nbcat-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nbcat-0.1.0.dist-info/entry_points.txt,sha256=a_byTgZyR_et6CxNcKCQlw1EHisUaIFRBRLh0tUQs2U,41
+nbcat-0.1.0.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
+nbcat-0.1.0.dist-info/RECORD,,

nbcat-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

nbcat-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+nbcat = nbcat.cli:main

nbcat-0.1.0.dist-info/licenses/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.