django-shellcraft 0.1.0__tar.gz

django_shellcraft-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.eggs/
+.pytest_cache/
+.ruff_cache/
+*.egg

django_shellcraft-0.1.0/CLAUDE.md

@@ -0,0 +1,103 @@
+# django-shellcraft
+
+## What is this?
+A Django package that brings Rails-style console ergonomics to the Django shell.
+Targets developers migrating from Ruby on Rails to Django who miss the
+`rails console` experience — specifically `awesome_print` style output,
+model shortcuts, and schema inspection.
+
+## Package identity
+- PyPI name: `django-shellcraft`
+- Importable name: `shellcraft`
+- INSTALLED_APPS entry: `'shellcraft'`
+- Management command: `python manage.py shellcraft`
+- Author: Siva
+- Python: 3.8+
+- Django: 3.2, 4.0, 4.1, 4.2, 5.0
+
+## Dependencies
+- django >= 3.2
+- django-extensions >= 3.0 (handles model auto-loading, we build on top)
+
+## Project structure
+django-shellcraft/
+├── shellcraft/
+│   ├── __init__.py                        # version only
+│   ├── printer.py                         # awesome_print style renderer
+│   ├── mixins.py                          # Rails-style shortcuts injected on models
+│   └── management/
+│       └── commands/
+│           └── shellcraft.py              # manage.py shellcraft command
+├── tests/
+│   └── test_printer.py
+├── pyproject.toml
+├── README.md
+└── LICENSE
+
+## Core features to build
+1. `User.find(1)`              → User.objects.get(pk=1)
+2. `User.all()`                → User.objects.all()  — pretty printed
+3. `User.where(active=True)`   → User.objects.filter() — pretty printed
+4. `User.first()`              → User.objects.first()
+5. `User.last()`               → User.objects.last()
+6. `User.count()`              → User.objects.count()
+7. `user.update(email="x")`    → instance-level update + save
+8. `user.destroy()`            → user.delete() alias
+9. `User.fields()`             → schema inspection, colored output
+10. `tables()`                 → list all models across all apps
+
+## printer.py — awesome_print style rules
+Color mapping (ANSI, pure Python — zero dependencies):
+- int, float     → blue
+- str            → yellow
+- True           → green
+- False          → red
+- None           → red
+- datetime, date → cyan
+- field types    → cyan
+- index [0],[1]  → gray
+
+Single record output:
+#<User:0x001> {
+    :id         => 1,
+    :username   => "siva",
+    :is_active  => true,
+}
+
+Multiple records output:
+[
+    [0] #<User:0x001> {
+            :id       => 1,
+            :username => "siva",
+        },
+    [1] #<User:0x002> {
+            :id       => 2,
+            :username => "kumar",
+        }
+]
+2 records
+
+## mixins.py — design decisions
+- Inject methods onto Django base Model class at shell startup only
+- Guard: only activate when running manage.py shellcraft
+- Collision check: warn if injected method name clashes with existing model method
+- Never activate in production — raise SystemExit if DEBUG is False
+
+## Key design decision
+Do NOT patch __repr__ globally. Pretty printing only happens through
+our helper methods (User.all(), User.find() etc). Raw User.objects.all()
+still shows Django default output. Intentional — predictable over magic.
+
+## Current status
+- [x] pyproject.toml
+- [x] shellcraft/__init__.py
+- [ ] shellcraft/printer.py
+- [ ] shellcraft/mixins.py
+- [ ] shellcraft/management/commands/shellcraft.py
+- [ ] tests/test_printer.py
+- [ ] README.md
+- [ ] LICENSE
+
+## Start here
+Begin with printer.py — everything else depends on it.
+Once colors and formatting work, mixins.py becomes straightforward.

django_shellcraft-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Siva
+
+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.

django_shellcraft-0.1.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: django-shellcraft
+Version: 0.1.0
+Summary: Rails-style console ergonomics for Django — pretty printing, model shortcuts, and schema inspection
+Author-email: Siva <sivanandam03@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Siva
+        
+        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
+Keywords: console,developer-tools,django,orm,rails,shell
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: django>=3.2
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-django>=4.8; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# django-shellcraft
+
+Rails-style console ergonomics for Django — pretty printing, model shortcuts, and schema inspection.
+
+Built for developers migrating from Ruby on Rails who miss the `rails console` experience.
+
+---
+
+## Installation
+
+```bash
+pip install django-shellcraft
+```
+
+Add to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "shellcraft",
+]
+```
+
+## Usage
+
+```bash
+python manage.py shellcraft
+```
+
+All models are auto-imported into the shell namespace. IPython is used when available, falling back to the standard Python REPL.
+
+> **Note:** shellcraft refuses to start when `DEBUG = False` as a production safety guard.
+
+---
+
+## Features
+
+### Model shortcuts
+
+All shortcuts are injected as classmethods/instance methods at shell startup. Raw `User.objects.all()` is unchanged — pretty printing only happens through shellcraft methods.
+
+| Method | Equivalent |
+|---|---|
+| `User.find(1)` | `User.objects.get(pk=1)` |
+| `User.all()` | `User.objects.all()` + pretty print |
+| `User.where(is_active=True)` | `User.objects.filter(...)` + pretty print |
+| `User.first()` | `User.objects.first()` + pretty print |
+| `User.last()` | `User.objects.last()` + pretty print |
+| `User.count()` | `User.objects.count()` |
+| `user.update(email="x@y.com")` | sets attrs + `save()` |
+| `user.destroy()` | `user.delete()` |
+| `User.fields()` | colored schema inspection |
+| `tables()` | list all models across all apps |
+
+### Pretty printing
+
+Single record:
+
+```
+#<User:0x7f3a> {
+    :id         => 1,
+    :username   => "siva",
+    :email      => "siva@example.com",
+    :is_active  => true,
+    :created_at => 2024-01-15 10:30:00,
+}
+```
+
+Multiple records:
+
+```
+[
+    [0] #<User:0x7f3a> {
+            :id       => 1,
+            :username => "siva",
+        },
+    [1] #<User:0x7f3b> {
+            :id       => 2,
+            :username => "kumar",
+        }
+]
+2 records
+```
+
+Color mapping:
+
+| Type | Color |
+|---|---|
+| `int`, `float` | blue |
+| `str` | yellow |
+| `True` | green |
+| `False`, `None` | red |
+| `datetime`, `date` | cyan |
+| field types | cyan |
+| record index `[0]` | gray |
+
+### Schema inspection
+
+```python
+User.fields()
+```
+
+```
+User {
+    :id          AutoField
+    :username    CharField
+    :email       CharField
+    :is_active   BooleanField
+    :created_at  DateTimeField
+    :group_id    ForeignKey     null: true
+}
+```
+
+### List all tables
+
+```python
+tables()
+```
+
+```
+  auth.User
+  auth.Group
+  auth.Permission
+  myapp.Post
+  myapp.Comment
+
+5 tables
+```
+
+### Manual pretty printing
+
+`ap()` is available directly for any model instance or queryset:
+
+```python
+ap(User.objects.filter(is_staff=True))
+```
+
+---
+
+## Requirements
+
+- Python 3.8+
+- Django 3.2, 4.0, 4.1, 4.2, or 5.0
+- django-extensions >= 3.0
+
+Optional: `ipython` for an enhanced shell experience.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/yourusername/django-shellcraft
+cd django-shellcraft
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## License
+
+MIT

django_shellcraft-0.1.0/README.md

@@ -0,0 +1,163 @@
+# django-shellcraft
+
+Rails-style console ergonomics for Django — pretty printing, model shortcuts, and schema inspection.
+
+Built for developers migrating from Ruby on Rails who miss the `rails console` experience.
+
+---
+
+## Installation
+
+```bash
+pip install django-shellcraft
+```
+
+Add to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "shellcraft",
+]
+```
+
+## Usage
+
+```bash
+python manage.py shellcraft
+```
+
+All models are auto-imported into the shell namespace. IPython is used when available, falling back to the standard Python REPL.
+
+> **Note:** shellcraft refuses to start when `DEBUG = False` as a production safety guard.
+
+---
+
+## Features
+
+### Model shortcuts
+
+All shortcuts are injected as classmethods/instance methods at shell startup. Raw `User.objects.all()` is unchanged — pretty printing only happens through shellcraft methods.
+
+| Method | Equivalent |
+|---|---|
+| `User.find(1)` | `User.objects.get(pk=1)` |
+| `User.all()` | `User.objects.all()` + pretty print |
+| `User.where(is_active=True)` | `User.objects.filter(...)` + pretty print |
+| `User.first()` | `User.objects.first()` + pretty print |
+| `User.last()` | `User.objects.last()` + pretty print |
+| `User.count()` | `User.objects.count()` |
+| `user.update(email="x@y.com")` | sets attrs + `save()` |
+| `user.destroy()` | `user.delete()` |
+| `User.fields()` | colored schema inspection |
+| `tables()` | list all models across all apps |
+
+### Pretty printing
+
+Single record:
+
+```
+#<User:0x7f3a> {
+    :id         => 1,
+    :username   => "siva",
+    :email      => "siva@example.com",
+    :is_active  => true,
+    :created_at => 2024-01-15 10:30:00,
+}
+```
+
+Multiple records:
+
+```
+[
+    [0] #<User:0x7f3a> {
+            :id       => 1,
+            :username => "siva",
+        },
+    [1] #<User:0x7f3b> {
+            :id       => 2,
+            :username => "kumar",
+        }
+]
+2 records
+```
+
+Color mapping:
+
+| Type | Color |
+|---|---|
+| `int`, `float` | blue |
+| `str` | yellow |
+| `True` | green |
+| `False`, `None` | red |
+| `datetime`, `date` | cyan |
+| field types | cyan |
+| record index `[0]` | gray |
+
+### Schema inspection
+
+```python
+User.fields()
+```
+
+```
+User {
+    :id          AutoField
+    :username    CharField
+    :email       CharField
+    :is_active   BooleanField
+    :created_at  DateTimeField
+    :group_id    ForeignKey     null: true
+}
+```
+
+### List all tables
+
+```python
+tables()
+```
+
+```
+  auth.User
+  auth.Group
+  auth.Permission
+  myapp.Post
+  myapp.Comment
+
+5 tables
+```
+
+### Manual pretty printing
+
+`ap()` is available directly for any model instance or queryset:
+
+```python
+ap(User.objects.filter(is_staff=True))
+```
+
+---
+
+## Requirements
+
+- Python 3.8+
+- Django 3.2, 4.0, 4.1, 4.2, or 5.0
+- django-extensions >= 3.0
+
+Optional: `ipython` for an enhanced shell experience.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/yourusername/django-shellcraft
+cd django-shellcraft
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## License
+
+MIT