marqetive-lib 0.1.0__tar.gz

marqetive_lib-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: marqetive-lib
+Version: 0.1.0
+Summary: Modern Python utilities for web APIs
+Keywords: api,utilities,web,http,marqetive
+Requires-Python: >=3.12
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: dev
+Provides-Extra: docs
+Requires-Dist: aiofiles (>=24.0.0)
+Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: mkdocs (>=1.5.0) ; extra == "docs"
+Requires-Dist: mkdocs-material (>=9.5.0) ; extra == "docs"
+Requires-Dist: mkdocstrings[python] (>=0.30.1) ; extra == "docs"
+Requires-Dist: pydantic (>=2.0.0)
+Requires-Dist: pyright (>=1.1.0) ; extra == "dev"
+Requires-Dist: pytest (>=9.0.0) ; extra == "dev"
+Requires-Dist: pytest-asyncio (>=1.3.0) ; extra == "dev"
+Requires-Dist: pytest-cov (>=7.0.0) ; extra == "dev"
+Requires-Dist: ruff (>=0.14.4) ; extra == "dev"
+Requires-Dist: tweepy (>=4.16.0,<5.0.0)
+Project-URL: Documentation, https://marqetive-lib.readthedocs.io
+Project-URL: Homepage, https://github.com/yourusername/marqetive-lib
+Project-URL: Issues, https://github.com/yourusername/marqetive-lib/issues
+Project-URL: Repository, https://github.com/yourusername/marqetive-lib
+Description-Content-Type: text/markdown
+
+# MarqetiveLib
+
+[![CI](https://github.com/yourusername/marqetive-lib/workflows/CI/badge.svg)](https://github.com/yourusername/marqetive-lib/actions)
+[![codecov](https://codecov.io/gh/yourusername/marqetive-lib/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/marqetive-lib)
+[![PyPI version](https://badge.fury.io/py/marqetive-lib.svg)](https://badge.fury.io/py/marqetive-lib)
+[![Python versions](https://img.shields.io/pypi/pyversions/marqetive-lib.svg)](https://pypi.org/project/marqetive-lib/)
+[![License](https://img.shields.io/github/license/yourusername/marqetive-lib.svg)](https://github.com/yourusername/marqetive-lib/blob/main/LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://marqetive-lib.readthedocs.io)
+
+Modern Python utilities for web APIs - Simple, type-safe, and async-ready.
+
+## Features
+
+- **🚀 Fast and Lightweight**: Built on httpx with minimal dependencies
+- **🔒 Type-Safe**: Full type hints and Pyright compliance for better IDE support
+- **📦 Zero Learning Curve**: Intuitive API design that feels natural
+- **🧪 Well Tested**: Comprehensive test coverage (>90%)
+- **📚 Excellent Documentation**: Clear examples and detailed API reference
+- **🔄 Async/Await Support**: Built for modern async Python applications
+- **✨ Developer Friendly**: Great error messages and helpful utilities
+
+## Installation
+
+```bash
+pip install marqetive-lib
+```
+
+Or with Poetry:
+
+```bash
+poetry add marqetive-lib
+```
+
+## Quick Start
+
+```python
+import asyncio
+from marqetive_lib import APIClient
+
+async def main():
+    async with APIClient(base_url="https://api.example.com") as client:
+        # Make a GET request
+        response = await client.get("/users/1")
+        print(f"User: {response.data['name']}")
+
+        # Make a POST request
+        new_user = {"name": "John Doe", "email": "john@example.com"}
+        response = await client.post("/users", data=new_user)
+        print(f"Created user ID: {response.data['id']}")
+
+asyncio.run(main())
+```
+
+## Core Features
+
+### Simple HTTP Client
+
+```python
+from marqetive_lib import APIClient
+
+async with APIClient(base_url="https://api.example.com") as client:
+    # GET request with query parameters
+    response = await client.get("/search", params={"q": "python"})
+
+    # POST request with JSON body
+    response = await client.post("/users", data={"name": "Alice"})
+
+    # Access response details
+    print(response.status_code)  # 200
+    print(response.data)         # Parsed JSON response
+    print(response.headers)      # Response headers
+```
+
+### Utility Functions
+
+```python
+from marqetive_lib.utils import (
+    format_response,
+    parse_query_params,
+    build_query_string,
+    merge_headers
+)
+
+# Format JSON responses beautifully
+data = {"users": [{"id": 1, "name": "Alice"}]}
+print(format_response(data, pretty=True, indent=2))
+
+# Parse URL query parameters
+params = parse_query_params("https://api.com/search?q=python&page=1")
+# {'q': ['python'], 'page': ['1']}
+
+# Build query strings
+query = build_query_string({"search": "api", "limit": 10})
+# "search=api&limit=10"
+
+# Merge HTTP headers
+headers = merge_headers(
+    {"Content-Type": "application/json"},
+    {"Authorization": "Bearer token"}
+)
+```
+
+### Type-Safe Responses
+
+```python
+from marqetive_lib import APIClient
+from pydantic import BaseModel
+
+class User(BaseModel):
+    id: int
+    name: str
+    email: str
+
+async with APIClient(base_url="https://api.example.com") as client:
+    response = await client.get("/users/1")
+    user = User(**response.data)  # Automatic validation
+    print(user.name)
+```
+
+## Documentation
+
+Full documentation is available at [marqetive-lib.readthedocs.io](https://marqetive-lib.readthedocs.io)
+
+- [Getting Started Guide](https://marqetive-lib.readthedocs.io/getting-started/)
+- [API Reference](https://marqetive-lib.readthedocs.io/api/core/)
+- [Examples](https://marqetive-lib.readthedocs.io/examples/basic/)
+- [Contributing Guide](https://marqetive-lib.readthedocs.io/contributing/)
+
+## Requirements
+
+- Python 3.9+
+- httpx >= 0.27.0
+- pydantic >= 2.0.0
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/marqetive-lib.git
+cd marqetive-lib
+
+# Install Poetry if you haven't already
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Install dependencies
+poetry install --with dev,docs
+
+# Activate virtual environment
+poetry shell
+```
+
+### Running Tests
+
+```bash
+# Run tests
+poetry run pytest
+
+# Run tests with coverage
+poetry run pytest --cov=src/marqetive_lib --cov-report=term-missing
+
+# Run tests for specific Python versions
+poetry run tox
+```
+
+### Code Quality
+
+```bash
+# Lint code with Ruff
+poetry run ruff check .
+
+# Format code with Ruff
+poetry run ruff format .
+
+# Type check with Pyright
+poetry run pyright src/
+```
+
+### Building Documentation
+
+```bash
+# Serve documentation locally with live reload
+poetry run mkdocs serve
+
+# Build static documentation
+poetry run mkdocs build
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on:
+
+- Code of conduct
+- Development workflow
+- Code style guidelines
+- Testing requirements
+- Pull request process
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes in each release.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Built with [httpx](https://www.python-httpx.org/) for HTTP requests
+- Uses [Pydantic](https://docs.pydantic.dev/) for data validation
+- Tested with [pytest](https://pytest.org/)
+- Documentation powered by [MkDocs Material](https://squidfunk.github.io/mkdocs-material/)
+
+## Support
+
+- **Documentation**: [marqetive-lib.readthedocs.io](https://marqetive-lib.readthedocs.io)
+- **Issues**: [GitHub Issues](https://github.com/yourusername/marqetive-lib/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/yourusername/marqetive-lib/discussions)
+
+## Links
+
+- **PyPI**: [pypi.org/project/marqetive-lib](https://pypi.org/project/marqetive-lib/)
+- **Source Code**: [github.com/yourusername/marqetive-lib](https://github.com/yourusername/marqetive-lib)
+- **Documentation**: [marqetive-lib.readthedocs.io](https://marqetive-lib.readthedocs.io)
+- **Changelog**: [CHANGELOG.md](CHANGELOG.md)
+

marqetive_lib-0.1.0/README.md

@@ -0,0 +1,226 @@
+# MarqetiveLib
+
+[![CI](https://github.com/yourusername/marqetive-lib/workflows/CI/badge.svg)](https://github.com/yourusername/marqetive-lib/actions)
+[![codecov](https://codecov.io/gh/yourusername/marqetive-lib/branch/main/graph/badge.svg)](https://codecov.io/gh/yourusername/marqetive-lib)
+[![PyPI version](https://badge.fury.io/py/marqetive-lib.svg)](https://badge.fury.io/py/marqetive-lib)
+[![Python versions](https://img.shields.io/pypi/pyversions/marqetive-lib.svg)](https://pypi.org/project/marqetive-lib/)
+[![License](https://img.shields.io/github/license/yourusername/marqetive-lib.svg)](https://github.com/yourusername/marqetive-lib/blob/main/LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://marqetive-lib.readthedocs.io)
+
+Modern Python utilities for web APIs - Simple, type-safe, and async-ready.
+
+## Features
+
+- **🚀 Fast and Lightweight**: Built on httpx with minimal dependencies
+- **🔒 Type-Safe**: Full type hints and Pyright compliance for better IDE support
+- **📦 Zero Learning Curve**: Intuitive API design that feels natural
+- **🧪 Well Tested**: Comprehensive test coverage (>90%)
+- **📚 Excellent Documentation**: Clear examples and detailed API reference
+- **🔄 Async/Await Support**: Built for modern async Python applications
+- **✨ Developer Friendly**: Great error messages and helpful utilities
+
+## Installation
+
+```bash
+pip install marqetive-lib
+```
+
+Or with Poetry:
+
+```bash
+poetry add marqetive-lib
+```
+
+## Quick Start
+
+```python
+import asyncio
+from marqetive_lib import APIClient
+
+async def main():
+    async with APIClient(base_url="https://api.example.com") as client:
+        # Make a GET request
+        response = await client.get("/users/1")
+        print(f"User: {response.data['name']}")
+
+        # Make a POST request
+        new_user = {"name": "John Doe", "email": "john@example.com"}
+        response = await client.post("/users", data=new_user)
+        print(f"Created user ID: {response.data['id']}")
+
+asyncio.run(main())
+```
+
+## Core Features
+
+### Simple HTTP Client
+
+```python
+from marqetive_lib import APIClient
+
+async with APIClient(base_url="https://api.example.com") as client:
+    # GET request with query parameters
+    response = await client.get("/search", params={"q": "python"})
+
+    # POST request with JSON body
+    response = await client.post("/users", data={"name": "Alice"})
+
+    # Access response details
+    print(response.status_code)  # 200
+    print(response.data)         # Parsed JSON response
+    print(response.headers)      # Response headers
+```
+
+### Utility Functions
+
+```python
+from marqetive_lib.utils import (
+    format_response,
+    parse_query_params,
+    build_query_string,
+    merge_headers
+)
+
+# Format JSON responses beautifully
+data = {"users": [{"id": 1, "name": "Alice"}]}
+print(format_response(data, pretty=True, indent=2))
+
+# Parse URL query parameters
+params = parse_query_params("https://api.com/search?q=python&page=1")
+# {'q': ['python'], 'page': ['1']}
+
+# Build query strings
+query = build_query_string({"search": "api", "limit": 10})
+# "search=api&limit=10"
+
+# Merge HTTP headers
+headers = merge_headers(
+    {"Content-Type": "application/json"},
+    {"Authorization": "Bearer token"}
+)
+```
+
+### Type-Safe Responses
+
+```python
+from marqetive_lib import APIClient
+from pydantic import BaseModel
+
+class User(BaseModel):
+    id: int
+    name: str
+    email: str
+
+async with APIClient(base_url="https://api.example.com") as client:
+    response = await client.get("/users/1")
+    user = User(**response.data)  # Automatic validation
+    print(user.name)
+```
+
+## Documentation
+
+Full documentation is available at [marqetive-lib.readthedocs.io](https://marqetive-lib.readthedocs.io)
+
+- [Getting Started Guide](https://marqetive-lib.readthedocs.io/getting-started/)
+- [API Reference](https://marqetive-lib.readthedocs.io/api/core/)
+- [Examples](https://marqetive-lib.readthedocs.io/examples/basic/)
+- [Contributing Guide](https://marqetive-lib.readthedocs.io/contributing/)
+
+## Requirements
+
+- Python 3.9+
+- httpx >= 0.27.0
+- pydantic >= 2.0.0
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/marqetive-lib.git
+cd marqetive-lib
+
+# Install Poetry if you haven't already
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Install dependencies
+poetry install --with dev,docs
+
+# Activate virtual environment
+poetry shell
+```
+
+### Running Tests
+
+```bash
+# Run tests
+poetry run pytest
+
+# Run tests with coverage
+poetry run pytest --cov=src/marqetive_lib --cov-report=term-missing
+
+# Run tests for specific Python versions
+poetry run tox
+```
+
+### Code Quality
+
+```bash
+# Lint code with Ruff
+poetry run ruff check .
+
+# Format code with Ruff
+poetry run ruff format .
+
+# Type check with Pyright
+poetry run pyright src/
+```
+
+### Building Documentation
+
+```bash
+# Serve documentation locally with live reload
+poetry run mkdocs serve
+
+# Build static documentation
+poetry run mkdocs build
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on:
+
+- Code of conduct
+- Development workflow
+- Code style guidelines
+- Testing requirements
+- Pull request process
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes in each release.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Built with [httpx](https://www.python-httpx.org/) for HTTP requests
+- Uses [Pydantic](https://docs.pydantic.dev/) for data validation
+- Tested with [pytest](https://pytest.org/)
+- Documentation powered by [MkDocs Material](https://squidfunk.github.io/mkdocs-material/)
+
+## Support
+
+- **Documentation**: [marqetive-lib.readthedocs.io](https://marqetive-lib.readthedocs.io)
+- **Issues**: [GitHub Issues](https://github.com/yourusername/marqetive-lib/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/yourusername/marqetive-lib/discussions)
+
+## Links
+
+- **PyPI**: [pypi.org/project/marqetive-lib](https://pypi.org/project/marqetive-lib/)
+- **Source Code**: [github.com/yourusername/marqetive-lib](https://github.com/yourusername/marqetive-lib)
+- **Documentation**: [marqetive-lib.readthedocs.io](https://marqetive-lib.readthedocs.io)
+- **Changelog**: [CHANGELOG.md](CHANGELOG.md)

marqetive_lib-0.1.0/pyproject.toml

@@ -0,0 +1,177 @@
+[build-system]
+requires = ["poetry-core>=2.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[project]
+name = "marqetive-lib"
+version = "0.1.0"
+description = "Modern Python utilities for web APIs"
+readme = "README.md"
+requires-python = ">=3.12"
+keywords = ["api", "utilities", "web", "http", "marqetive"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "httpx>=0.28.1",
+    "pydantic>=2.0.0",
+    "tweepy (>=4.16.0,<5.0.0)",
+    "aiofiles>=24.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.0.0",
+    "pytest-cov>=7.0.0",
+    "pytest-asyncio>=1.3.0",
+    "ruff>=0.14.4",
+    "pyright>=1.1.0",
+]
+docs = [
+    "mkdocs>=1.5.0",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.30.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/yourusername/marqetive-lib"
+Documentation = "https://marqetive-lib.readthedocs.io"
+Repository = "https://github.com/yourusername/marqetive-lib"
+Issues = "https://github.com/yourusername/marqetive-lib/issues"
+
+[tool.poetry]
+packages = [{ include = "marqetive", from = "src" }]
+
+# Poetry-specific dependency management
+[tool.poetry.dependencies]
+python = "^3.12"
+httpx = "^0.28.1"
+pydantic = "^2.0.0"
+tweepy = "^4.16.0"
+aiofiles = "^24.0.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^9.0.0"
+pytest-cov = "^7.0.0"
+pytest-asyncio = "^1.3.0"
+ruff = "^0.14.4"
+pyright = "^1.1.0"
+ipython = "^9.7.0"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.5.0"
+mkdocs-material = "^9.5.0"
+mkdocstrings = { extras = ["python"], version = "^0.30.1" }
+
+# Ruff configuration
+[tool.ruff]
+# Target Python 3.12+
+target-version = "py312"
+
+# Line length to match Black's default
+line-length = 88
+
+# Directories to exclude
+exclude = [".git", ".venv", "__pycache__", "build", "dist", "*.egg-info"]
+
+[tool.ruff.lint]
+# Enable rule sets
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+    "ARG", # flake8-unused-arguments
+    "SIM", # flake8-simplify
+]
+
+# Rules to ignore
+ignore = [
+    "E501", # line too long (handled by formatter)
+    "B008", # do not perform function calls in argument defaults
+]
+
+# Allow autofix for all enabled rules
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Use double quotes for strings
+quote-style = "double"
+
+# Indent with spaces
+indent-style = "space"
+
+# Respect magic trailing commas
+skip-magic-trailing-comma = false
+
+# Auto-detect line endings
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+known-first-party = ["marqetive"]
+
+# Pyright configuration
+[tool.pyright]
+# Paths to include in analysis
+include = ["src"]
+
+# Paths to exclude
+exclude = ["**/__pycache__", "**/node_modules", ".venv", "build", "dist"]
+
+# Python version
+pythonVersion = "3.12"
+pythonPlatform = "All"
+
+# Type checking mode: "off", "basic", "standard", "strict"
+typeCheckingMode = "standard"
+
+# Reporting options (incremental strictness)
+reportMissingImports = true
+reportMissingTypeStubs = false
+reportUnusedImport = "warning"
+reportUnusedClass = "warning"
+reportUnusedFunction = "warning"
+reportUnusedVariable = "warning"
+reportDuplicateImport = "warning"
+reportOptionalSubscript = "error"
+reportOptionalMemberAccess = "error"
+reportOptionalCall = "error"
+reportOptionalIterable = "error"
+reportOptionalContextManager = "error"
+reportOptionalOperand = "error"
+
+# Stricter checks (enable gradually)
+reportUnknownParameterType = "none"
+reportUnknownArgumentType = "none"
+reportUnknownLambdaType = "none"
+reportUnknownVariableType = "none"
+reportUnknownMemberType = "none"
+
+# Use stub packages when available
+stubPath = "typings"
+
+# Pytest configuration
+[tool.pytest.ini_options]
+minversion = "8.0"
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--cov=marqetive",
+    "--cov-report=term-missing",
+]
+testpaths = ["tests"]
+pythonpath = ["src"]