respectify 0.1.0__tar.gz

respectify-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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/
+
+# 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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

respectify-0.1.0/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: respectify
+Version: 0.1.0
+Summary: Python client library for the Respectify API
+Project-URL: Homepage, https://respectify.ai
+Project-URL: Documentation, https://docs.respectify.org
+Project-URL: Repository, https://github.com/respectify/respectify-python
+Project-URL: Issues, https://github.com/respectify/respectify-python/issues
+Author-email: Respectify <dave@respectify.ai>
+License-Expression: MIT
+Keywords: abuse-detection,api,civility,comment,content-filtering,discourse,discussion,dogwhistle,moderation,respectify,spam,toxicity
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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 :: Communications
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Filters
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: beartype>=0.15.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: python-dotenv>=1.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.0.280; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser>=2.0.0; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints>=1.24.0; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# Respectify Python Client
+
+[![PyPI version](https://badge.fury.io/py/respectify.svg)](https://badge.fury.io/py/respectify)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A Python client library for the [Respectify API](https://respectify.ai), providing both synchronous and asynchronous interfaces for comment moderation, spam detection, toxicity analysis, and dogwhistle detection.
+
+## Features
+
+- **🔄 Dual Interface**: Both synchronous (`RespectifyClient`) and asynchronous (`RespectifyAsyncClient`) clients
+- **🛡️ Type Safety**: Full type hints with Pydantic schema validation  
+- **📊 Comprehensive**: All Respectify API endpoints supported
+- **⚡ Efficient**: Megacall support for multiple analyses in single requests
+- **🚨 Error Handling**: Custom exception classes for different API error conditions
+- **🐍 Modern Python**: Uses httpx for HTTP requests, beartype for runtime type checking
+
+## Installation
+
+```bash
+pip install respectify
+```
+
+## Quick Start
+
+### Synchronous Client
+
+```python
+from respectify import RespectifyClient
+
+# Initialize client
+client = RespectifyClient(
+    email="your-email@example.com",
+    api_key="your-api-key"
+)
+
+# Initialize a topic
+topic = client.init_topic_from_text("This is my article content")
+article_id = topic.article_id
+
+# Check if a comment is spam
+spam_result = client.check_spam("Great post!", article_id)
+print(f"Is spam: {spam_result.is_spam}")
+
+# Evaluate comment quality and toxicity
+score = client.evaluate_comment("This is a thoughtful comment", article_id)
+print(f"Quality: {score.overall_score}/5, Toxicity: {score.toxicity_score:.2f}")
+```
+
+### Asynchronous Client
+
+```python
+import asyncio
+from respectify import RespectifyAsyncClient
+
+async def main():
+    client = RespectifyAsyncClient(
+        email="your-email@example.com",
+        api_key="your-api-key"
+    )
+    
+    # Initialize topic
+    topic = await client.init_topic_from_text("Article content")
+    article_id = topic.article_id
+    
+    # Run multiple analyses concurrently
+    spam_task = client.check_spam("Great post!", article_id)
+    score_task = client.evaluate_comment("Thoughtful comment", article_id)
+    
+    spam_result, score_result = await asyncio.gather(spam_task, score_task)
+    
+    print(f"Spam: {spam_result.is_spam}, Quality: {score_result.overall_score}/5")
+
+asyncio.run(main())
+```
+
+### Megacall for Efficiency
+
+Perform multiple analyses in a single API call:
+
+```python
+# Instead of multiple separate calls...
+result = client.megacall(
+    comment="Test comment",
+    article_id=article_id,
+    include_spam=True,
+    include_relevance=True, 
+    include_comment_score=True,
+    include_dogwhistle=True
+)
+
+# Access individual results
+print(f"Spam: {result.spam.is_spam if result.spam else 'N/A'}")
+print(f"Quality: {result.comment_score.overall_score if result.comment_score else 'N/A'}/5")
+print(f"On topic: {result.relevance.on_topic.is_on_topic if result.relevance else 'N/A'}")
+print(f"Dogwhistles: {result.dogwhistle.detection.dogwhistles_detected if result.dogwhistle else 'N/A'}")
+```
+
+## API Reference
+
+### Available Methods
+
+**Topic Management:**
+- `init_topic_from_text(text, topic_description=None)` - Initialize topic from text content
+- `init_topic_from_url(url, topic_description=None)` - Initialize topic from URL
+
+**Comment Analysis:**
+- `check_spam(comment, article_id)` - Spam detection
+- `evaluate_comment(comment, article_id)` - Quality scoring and toxicity analysis  
+- `check_relevance(comment, article_id, banned_topics=None)` - Relevance and banned topic detection
+- `check_dogwhistle(comment, sensitive_topics=None, dogwhistle_examples=None)` - Dogwhistle detection
+
+**Batch Operations:**
+- `megacall(comment, article_id, **options)` - Multiple analyses in one call
+
+**Authentication:**
+- `check_user_credentials()` - Verify API credentials
+
+### Response Schemas
+
+All API responses are parsed into strongly-typed Pydantic models:
+
+- `InitTopicResponse` - Topic initialization result
+- `SpamDetectionResult` - Spam analysis with confidence scores
+- `CommentScore` - Quality metrics and toxicity analysis
+- `CommentRelevanceResult` - Topic relevance and banned topic detection  
+- `DogwhistleResult` - Dogwhistle detection with detailed analysis
+- `MegaCallResult` - Container for multiple analysis results
+- `UserCheckResponse` - Authentication verification result
+
+### Error Handling
+
+```python
+from respectify import (
+    RespectifyError,           # Base exception
+    AuthenticationError,       # Invalid credentials (401)
+    BadRequestError,          # Invalid parameters (400)
+    PaymentRequiredError,     # Subscription required (402)
+    ServerError              # Server issues (500+)
+)
+
+try:
+    result = client.check_spam("test", article_id)
+except AuthenticationError:
+    print("Please check your API credentials")
+except PaymentRequiredError:
+    print("This feature requires a paid plan")
+except BadRequestError as e:
+    print(f"Invalid request: {e.message}")
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file for testing:
+
+```bash
+RESPECTIFY_EMAIL=your-email@example.com
+RESPECTIFY_API_KEY=your-api-key
+RESPECTIFY_BASE_URL=https://app.respectify.org  # Optional
+REAL_ARTICLE_ID=your-test-article-uuid         # Optional
+```
+
+### Client Options
+
+```python
+client = RespectifyClient(
+    email="your-email@example.com",
+    api_key="your-api-key",
+    base_url="https://app.respectify.org",  # Optional, defaults to production
+    version="0.2",                          # Optional, API version
+    timeout=30.0                           # Optional, request timeout in seconds
+)
+```
+
+## Development
+
+### Running Tests
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests with real API (requires .env file)
+pytest tests/ -v
+
+# Run tests with coverage
+pytest tests/ --cov=respectify --cov-report=html
+```
+
+### Building Documentation
+
+```bash
+# Install documentation dependencies  
+pip install -e ".[docs]"
+
+# Build documentation
+cd docs
+make html
+
+# Serve documentation locally
+python -m http.server 8000 --directory _build/html
+```
+
+### Code Quality
+
+```bash
+# Run ruff linting and formatting
+ruff check respectify/
+ruff format respectify/
+
+# Beartype provides runtime type checking automatically
+# No separate type checking step needed!
+```
+
+## Requirements
+
+- Python 3.9+
+- httpx >= 0.24.0
+- pydantic >= 2.0.0  
+- beartype >= 0.15.0
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- **Documentation**: [Full API documentation](https://docs.respectify.org)
+- **Issues**: [GitHub Issues](https://github.com/respectify/respectify-python/issues)
+- **Website**: [Respectify.ai](https://respectify.ai)
+
+## Changelog
+
+### v0.1.0 (2025-01-XX)
+
+- Initial release
+- Synchronous and asynchronous client support
+- Complete API coverage for all Respectify endpoints
+- Comprehensive type safety with Pydantic schemas
+- Megacall support for efficient batch operations
+- Full test suite with real API integration
+- Sphinx documentation with examples