scitex 2.13.0__py3-none-any.whl → 2.15.1__py3-none-any.whl

scitex/scholar/docs/to_claude/guidelines/python/django.md

@@ -1,217 +0,0 @@
-<!-- ---
-!-- Timestamp: 2025-05-21 03:55:50
-!-- Author: ywatanabe
-!-- File: /home/ywatanabe/.dotfiles/.claude/to_claude/guidelines/guidelines-programming-Python-Django-Rules.md
-!-- --- -->
-
-
-# Python Django Guidelines
-
-## Project Structure
-
-Django projects should follow this structure to maintain consistency and organization:
-
-```
-project-name/
-├── apps/                  # All Django applications
-│   ├── about_app/         # Example app for about/legal pages
-│   │   ├── admin.py       # Admin configuration
-│   │   ├── apps.py        # App configuration
-│   │   ├── __init__.py
-│   │   ├── migrations/    # Database migrations
-│   │   ├── models.py      # Data models
-│   │   ├── templates/     # App-specific templates
-│   │   │   └── about_app/
-│   │   │       ├── contact.html
-│   │   │       ├── privacy_policy.html
-│   │   │       └── terms_of_use.html
-│   │   ├── tests.py       # Unit tests
-│   │   ├── urls.py        # URL routing for this app
-│   │   └── views.py       # View functions/classes
-│   ├── auth_app/          # Authentication related functionality
-│   └── api_app/           # API functionality
-├── config/                # Project configuration
-│   ├── settings/
-│   │   ├── __init__.py
-│   │   ├── base.py        # Base settings shared across environments
-│   │   ├── development.py # Development-specific settings
-│   │   └── production.py  # Production-specific settings
-│   ├── urls.py            # Project-level URL routing
-│   └── wsgi.py            # WSGI configuration
-├── static/                # Static files (CSS, JS, images)
-│   ├── css/
-│   ├── js/
-│   └── images/
-├── media/                 # User-uploaded files
-├── templates/             # Project-wide templates
-│   └── base.html          # Base template for inheritance
-├── manage.py              # Django management script
-├── requirements/
-│   ├── base.txt           # Base requirements
-│   ├── development.txt    # Development requirements
-│   └── production.txt     # Production requirements
-└── .env.example           # Example environment variables
-```
-
-## App Organization
-
-1. Create focused apps with specific responsibilities
-2. Keep apps small and modular (single responsibility principle)
-3. Use descriptive names for apps that reflect their purpose
-
-## Models
-
-1. Define proper relationships (ForeignKey, ManyToMany, OneToOne)
-2. Include docstrings for all models
-3. Define `__str__` methods for all models
-4. Use appropriate field types
-5. Set reasonable defaults and constraints
-
-```python
-class Article(models.Model):
-    """Represents a blog article with metadata."""
-    
-    title = models.CharField(max_length=200)
-    slug = models.SlugField(unique=True)
-    content = models.TextField()
-    created_at = models.DateTimeField(auto_now_add=True)
-    updated_at = models.DateTimeField(auto_now=True)
-    author = models.ForeignKey('auth.User', on_delete=models.CASCADE)
-    
-    class Meta:
-        ordering = ['-created_at']
-        
-    def __str__(self):
-        return self.title
-        
-    def get_absolute_url(self):
-        return reverse('article_detail', kwargs={'slug': self.slug})
-```
-
-## Views
-
-1. Use class-based views when possible
-2. Keep views focused on a single task
-3. Move business logic to models or services
-4. Implement proper permission handling
-
-```python
-class ArticleDetailView(DetailView):
-    model = Article
-    template_name = 'blog/article_detail.html'
-    context_object_name = 'article'
-    
-    def get_context_data(self, **kwargs):
-        context = super().get_context_data(**kwargs)
-        context['related_articles'] = self.object.get_related_articles()
-        return context
-```
-
-## Templates
-
-1. Use template inheritance to reduce duplication
-2. Keep templates focused on presentation
-3. Minimize template logic
-4. Use template tags and filters for complex presentation logic
-
-```html
-{% extends "base.html" %}
-
-{% block title %}{{ article.title }}{% endblock %}
-
-{% block content %}
-<article>
-    <h1>{{ article.title }}</h1>
-    <div class="meta">
-        Published {{ article.created_at|date:"F j, Y" }} by {{ article.author.username }}
-    </div>
-    <div class="content">
-        {{ article.content|safe }}
-    </div>
-</article>
-{% endblock %}
-```
-
-## URLs
-
-1. Use named URL patterns
-2. Group related URLs under namespaces
-3. Keep URL patterns clean and readable
-
-```python
-from django.urls import path
-from . import views
-
-app_name = 'blog'
-
-urlpatterns = [
-    path('', views.ArticleListView.as_view(), name='article_list'),
-    path('<slug:slug>/', views.ArticleDetailView.as_view(), name='article_detail'),
-    path('tag/<slug:tag_slug>/', views.TaggedArticleListView.as_view(), name='tag_detail'),
-]
-```
-
-## Testing
-
-1. Write tests for all models, views, and forms
-2. Use Django's testing utilities
-3. Aim for high test coverage
-4. Test edge cases and failure scenarios
-
-```python
-from django.test import TestCase
-from django.urls import reverse
-from .models import Article
-
-class ArticleModelTest(TestCase):
-    def setUp(self):
-        self.article = Article.objects.create(
-            title="Test Article",
-            slug="test-article",
-            content="Test content",
-            author_id=1
-        )
-    
-    def test_article_creation(self):
-        self.assertEqual(self.article.title, "Test Article")
-        self.assertEqual(self.article.slug, "test-article")
-    
-    def test_get_absolute_url(self):
-        self.assertEqual(
-            self.article.get_absolute_url(),
-            reverse('blog:article_detail', kwargs={'slug': 'test-article'})
-        )
-```
-
-## Settings
-
-1. Split settings into base, development, and production
-2. Use environment variables for sensitive information
-3. Keep secrets out of version control
-4. Configure proper logging
-
-## Security
-
-1. Validate all user input
-2. Use Django's CSRF protection
-3. Implement proper authentication and authorization
-4. Keep dependencies updated
-5. Follow the principle of least privilege
-
-## Performance
-
-1. Use Django's caching framework
-2. Optimize database queries with select_related and prefetch_related
-3. Use pagination for large datasets
-4. Monitor query performance with Django Debug Toolbar
-
-## Deployment
-
-1. Use a proper WSGI/ASGI server (Gunicorn, uWSGI)
-2. Configure a reverse proxy (Nginx, Apache)
-3. Set DEBUG=False in production
-4. Serve static files efficiently
-5. Use a CDN where appropriate
-6. Implement proper error handling and monitoring
-
-<!-- EOF -->

scitex/scholar/docs/to_claude/guidelines/python/env.md

@@ -1,10 +0,0 @@
-<!-- ---
-!-- Timestamp: 2025-06-14 06:52:30
-!-- Author: ywatanabe
-!-- File: /home/ywatanabe/.dotfiles/.claude/to_claude/guidelines/python/IMPORTANT-env.md
-!-- --- -->
-
-## Python Environment
-Ensure python environment is actiavted by: `source .venv/bin/activate`
-
-<!-- EOF -->

scitex/scholar/docs/to_claude/guidelines/python/general.md

@@ -1,55 +0,0 @@
-<!-- ---
-!-- Timestamp: 2025-06-03 15:23:41
-!-- Author: ywatanabe
-!-- File: /ssh:ywatanabe@sp:/home/ywatanabe/.dotfiles/.claude/to_claude/guidelines/python/IMPORTANT-general.md
-!-- --- -->
-
-## SCITEX Rule
-**!!! IMPORATANT !!!**
-**ANY PYTHON SCRIPTS MUST BE WRITTEN IN THE SCITEX FORMAT EXPLAINED BELOW.**
-THE EXCEPTIONS ARE:
-    - Pacakges authored by others
-    - Source (`./src`) of pip packages to reduce dependency
-THUS, SCITEX MUST BE USED IN:
-- `./scripts`
-- `./tests`
-- `./examples`
-For details, see the scitex guideline (`./TOP-MOST-IMPORTANT-stx.md`).
-
-## `chmod +x *.py`
-Do not forget to add the executable permission (`chmod +x`) for `*.py` files.
-
-## `matplotlib.use("Agtg")`
-Use `Agg` for matplotlib backend. Do not show images but save to file.
-    ``` python
-    import matplotlib
-    matplotlib.use("Agg")
-    ```
-
-## Lint with Black
-IMPORTANT: LINT ALL .PY SCRIPTS USING `black` (`~/.venv/bin/black`)
-
-## Run scripts
-Do not hesitate to run scripts as long as they are destructive.
-Using timeout would be beneficial if scripts will take long time.
-
-## Use CUDA
-When a GPU can accelerate processing, we prioritize GPU over CPU. 
-If GPU is not available and CPU processing will take a long time, please let us know.
-
-## Plotting functions
-Plotting functions should `return fig` for consistency
-Save, show can be handled outside of plotting functions.
-``` python
-def plot_xxx(...):
-    return fig
-    
-def main(args):
-    fig = plot_xxx(...)
-```
-
-## Your Understanding Check
-Did you understand the guideline? If yes, please say:
-`CLAUDE UNDERSTOOD: <THIS FILE PATH HERE>`
-
-<!-- EOF -->

scitex/scholar/docs/to_claude/guidelines/python/official/cipdb-README.md

@@ -1,219 +0,0 @@
-<!-- ---
-!-- Timestamp: 2025-08-30 06:36:14
-!-- Author: ywatanabe
-!-- File: /home/ywatanabe/.claude/to_claude/guidelines/python/cipdb.md
-!-- --- -->
-
-########################################
-Official README.md
-########################################
-
-``` markdown
-# cipdb - Conditional iPDB
-
-Simple conditional debugging for Python with ID-based breakpoint control.
-
-[![PyPI version](https://badge.fury.io/py/cipdb.svg)](https://badge.fury.io/py/cipdb)
-[![Python 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-## Installation
-
-```bash
-pip install cipdb
-```
-
-## Quick Start
-
-### Control by Global State Call in Python
-
-```python
-# Disable all debugging programmatically
-cipdb.disable()
-```
-
-### Controll by Environmental Variable
-
-``` python
-CIPDB_ID=false python your_script.py
-```
-
-### Control by Boolean
-
-```python
-import cipdb
-
-cipdb.set_trace()       # Identical with ipdb.set_trace()
-cipdb.set_trace(False)  # Identical with pass
-cipdb.set_trace(os.getenv("DEBUG")) # Development vs Production
-cipdb.set_trace(os.getenv("AGENT_ID")=="DebuggingAgent_01") # Runner Specific for debugging by multiple agent
-```
-
-### Control by Breakpoint IDs
-``` python
-# your_script.py
-def process_user(user):
-    cipdb.set_trace(id="validate")
-    validate(user)
-    
-    cipdb.set_trace(id="save")
-    save_user(user)
-    
-    cipdb.set_trace(id="notify")
-    send_notification(user)
-```
-
-``` bash
-# Development mode: All ID breakpoints work (no env vars needed)
-python your_script.py                            # All ID breakpoints trigger
-
-# Production mode: Control with environment variables
-CIPDB_IDS=validate,save python your_script.py   # Only stops at validate and save
-CIPDB_IDS=save python your_script.py            # Only stops at save
-CIPDB_ID=save python your_script.py             # Only stops at save (Equivalent to CIPDB_IDS=save)
-```
-
-## Priority Logic
-
-Global Control > `CIPDB=false` Environmental Variable > ID Matching > Boolean Conditioning
-
-## License
-
-MIT
-```
-
-
-########################################
-Official Example.py
-########################################
-
-``` python
-#!/usr/bin/env python3
-'''Examples demonstrating cipdb usage.'''
-
-import os
-import cipdb
-
-
-def example_simple():
-    '''Basic debugging.'''
-    print("Example: Simple debugging")
-    x = 10
-    
-    # Always debug
-    # cipdb.set_trace()
-    
-    # Never debug
-    cipdb.set_trace(False)
-    
-    print(f"x = {x}")
-
-
-def example_id_based():
-    '''ID-based breakpoint debugging.'''
-    print("\nExample: ID-based debugging")
-    
-    # Multiple breakpoints with different IDs
-    data = [1, 2, 3, 4, 5]
-    
-    cipdb.set_trace(id="start")
-    print("Starting processing...")
-    
-    for item in data:
-        cipdb.set_trace(id="loop")
-        result = item * 2
-        
-    cipdb.set_trace(id="end")
-    print("Processing complete")
-    
-    # Run with: CIPDB_ID=loop python demo.py
-    # or: CIPDB_IDS=loop,end python demo.py
-
-
-def example_conditional():
-    '''Conditional debugging.'''
-    print("\nExample: Conditional debugging")
-    
-    users = ['alice', 'bob', 'admin', 'charlie']
-    
-    for user in users:
-        # Only debug for admin user
-        cipdb.set_trace(user == 'admin', id=f"user-{user}")
-        print(f"Processing {user}")
-
-
-def example_environment():
-    '''Environment-based debugging.'''
-    print("\nExample: Environment debugging")
-    
-    # Only debug in development
-    cipdb.set_trace(os.getenv("ENV") == "development")
-    
-    # Only debug if DEBUG is set
-    cipdb.set_trace(os.getenv("DEBUG"))
-    
-    print("Environment checks complete")
-
-
-def example_production_safety():
-    '''Production safety patterns.'''
-    print("\nExample: Production safety")
-    
-    # Method 1: Environment variable
-    cipdb.set_trace(os.getenv("DEBUG"))  # Only triggers if DEBUG is set
-    
-    # Method 2: Global disable
-    if os.environ.get('ENV') == 'production':
-        cipdb.disable()
-    
-    # Method 3: Set CIPDB=false in production
-    # All cipdb calls are disabled when CIPDB=false
-    
-    cipdb.set_trace(id="never-in-prod")
-    print("Production safe!")
-
-
-def example_debugging_specific_issue():
-    '''Debug a specific issue using IDs.'''
-    print("\nExample: Debugging specific issue")
-    
-    def process_batch(batch_id, data):
-        cipdb.set_trace(id=f"batch-{batch_id}")
-        # Complex processing here
-        return len(data)
-    
-    batches = [
-        (1, [1, 2, 3]),
-        (2, [4, 5]),
-        (3, [6, 7, 8, 9]),
-    ]
-    
-    for batch_id, data in batches:
-        result = process_batch(batch_id, data)
-        print(f"Batch {batch_id}: {result} items")
-    
-    # Debug only batch 2:
-    # CIPDB_ID=batch-2 python demo.py
-
-
-if __name__ == "__main__":
-    print("cipdb Examples")
-    print("=" * 40)
-    
-    # Uncomment to test different modes:
-    # os.environ["DEBUG"] = "true"
-    # os.environ["ENV"] = "development"
-    # os.environ["CIPDB_ID"] = "loop"
-    
-    example_simple()
-    example_id_based()
-    example_conditional()
-    example_environment()
-    example_production_safety()
-    example_debugging_specific_issue()
-    
-    print("\n" + "=" * 40)
-    print("Examples complete!")
-```
-
-<!-- EOF -->