| Name | ggnomad-sdk JSON |
| Version |
0.1.2a20251021152437
JSON |
| download |
| home_page | None |
| Summary | Python SDK for Boiler API - A GraphQL-based SDK for quick API integrations |
| upload_time | 2025-10-21 15:24:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c) 2025 Burdenoff Consultancy Services Private Limited, Algoshred Technologies Private Limited and all sister companies.
All rights reserved.
This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without the express written permission of the copyright holders.
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.
For licensing inquiries, please contact: legal@algoshred.com |
| keywords |
algoshred
api-client
ggnomad
graphql
python
sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Ggnomad Sdk-python
A Python SDK ggnomad for building GraphQL-based API clients quickly. This SDK provides a structured foundation for creating Python SDKs that interact with GraphQL APIs, similar to the Node.js workspace SDK but adapted for Python.
## Features
- 🚀 **Async/await support** - Built with modern Python async patterns
- 🔐 **Authentication handling** - Token management and refresh logic
- 📦 **Modular architecture** - Organized by feature modules
- 🔧 **Type hints** - Full typing support with mypy
- 🧪 **Testing ready** - Pytest configuration included
- 📚 **Documentation** - Sphinx-ready documentation setup
- 🛠️ **Development tools** - Code formatting, linting, and pre-commit hooks
## Installation
```bash
# Install from PyPI (when published)
pip install ggnomad-sdk
# Or install in development mode
pip install -e .
# Install with development dependencies
pip install -e ".[dev]"
```
## Quick Start
```python
import asyncio
from ggnomad_sdk import BoilerSDK, BoilerSDKConfig
from ggnomad_sdk.types.common import UserRegisterInput
async def main():
# Initialize the SDK
config = BoilerSDKConfig(
endpoint="https://api.example.com/graphql",
api_key="your-api-key" # Optional
)
sdk = BoilerSDK(config)
try:
# Register a new user
user_input = UserRegisterInput(
email="user@example.com",
name="John Doe",
password="secure_password"
)
user = await sdk.auth.register(user_input)
print(f"User registered: {user.name}")
# Set authentication tokens
sdk.set_tokens(
access_token="your-access-token",
refresh_token="your-refresh-token"
)
# Get current user
current_user = await sdk.users.get_current_user()
print(f"Current user: {current_user.name}")
finally:
await sdk.client.close()
# Run the example
asyncio.run(main())
```
## Configuration
The SDK is configured using the `BoilerSDKConfig` class:
```python
from ggnomad_sdk import BoilerSDKConfig
config = BoilerSDKConfig(
endpoint="https://api.example.com/graphql", # Required
api_key="your-api-key", # Optional
access_token="your-access-token", # Optional
refresh_token="your-refresh-token", # Optional
timeout=30.0 # Optional, default: 30.0
)
```
## Available Modules
The SDK is organized into the following modules:
- **auth** - Authentication operations (register, login, logout, etc.)
- **user** - User management operations
- **workspace** - Workspace operations (TODO)
- **rbac** - Role-based access control (TODO)
- **team** - Team management (TODO)
- **project** - Project operations (TODO)
- **resources** - Resource management (TODO)
- **billing** - Billing operations (TODO)
- **organization** - Organization management (TODO)
- **payment** - Payment processing (TODO)
- **quota** - Quota management (TODO)
- **store** - Store operations (TODO)
- **support** - Support ticket management (TODO)
- **usage** - Usage analytics (TODO)
- **utils** - Utility functions (TODO)
- **addon** - Add-on management (TODO)
- **plan** - Plan management (TODO)
- **product** - Product management (TODO)
- **config** - Configuration management (TODO)
## Examples
See the `examples/` directory for more detailed usage examples:
- `basic_usage.py` - Basic SDK operations
- `advanced_usage.py` - Advanced features and error handling
## Development
### Setup Development Environment
```bash
# Clone the repository
git clone <repository-url>
cd ggnomad-sdk-python
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\\Scripts\\activate
# Install development dependencies
pip install -e ".[dev]"
# Install pre-commit hooks
pre-commit install
```
### Code Quality
The project uses several tools for code quality:
```bash
# Format code
black src/ tests/ examples/
isort src/ tests/ examples/
# Lint code
flake8 src/ tests/ examples/
mypy src/
# Run tests
pytest
# Run tests with coverage
pytest --cov=ggnomad_sdk --cov-report=html
```
### Testing
```bash
# Run all tests
pytest
# Run specific test file
pytest tests/test_auth.py
# Run with coverage
pytest --cov=ggnomad_sdk
# Run only unit tests
pytest -m unit
# Run only integration tests
pytest -m integration
```
## Project Structure
```
ggnomad-sdk-python/
├── src/
│ └── ggnomad_sdk/
│ ├── __init__.py # Main SDK class
│ ├── client/ # HTTP/GraphQL client
│ ├── auth/ # Authentication module
│ ├── user/ # User management
│ ├── workspace/ # Workspace operations
│ ├── types/ # Type definitions
│ └── ... # Other modules
├── tests/ # Test files
├── examples/ # Usage examples
├── docs/ # Documentation
├── pyproject.toml # Package configuration
├── requirements.txt # Production dependencies
└── requirements-dev.txt # Development dependencies
```
## Contributing
1. Fork the repository
2. Create a feature branch: `git checkout -b feature-name`
3. Make your changes and add tests
4. Run the test suite: `pytest`
5. Commit your changes: `git commit -am 'Add feature'`
6. Push to the branch: `git push origin feature-name`
7. Create a Pull Request
## Type Hints
This SDK is fully typed and supports mypy type checking:
```bash
mypy src/ggnomad_sdk
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for version history and changes.
## Support
- 📖 **Documentation**: [docs.algoshred.com/sdk/python](https://docs.algoshred.com/sdk/python)
- 🐛 **Issues**: [GitHub Issues](https://github.com/algoshred/ggnomad-sdk-python/issues)
- 💬 **Discussions**: [GitHub Discussions](https://github.com/algoshred/ggnomad-sdk-python/discussions)
## Related Projects
- [Workspaces SDK Node.js](../workspaces-sdk-node) - The Node.js version this SDK is based on
- [Boiler Frontend](../ggnomad-frontend) - Frontend ggnomad
- [Boiler Backend](../ggnomad-python-be-graphql) - Python GraphQL backend ggnomad
Raw data
{
"_id": null,
"home_page": null,
"name": "ggnomad-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"Vignesh T.V\" <vignesh@algoshred.com>",
"keywords": "algoshred, api-client, ggnomad, graphql, python, sdk",
"author": null,
"author_email": "\"Vignesh T.V\" <vignesh@algoshred.com>",
"download_url": "https://files.pythonhosted.org/packages/67/13/27069800beb2e8591f1fff24f6cb82b07bf324ca6778868f9d4300802fc6/ggnomad_sdk-0.1.2a20251021152437.tar.gz",
"platform": null,
"description": "# Ggnomad Sdk-python\n\nA Python SDK ggnomad for building GraphQL-based API clients quickly. This SDK provides a structured foundation for creating Python SDKs that interact with GraphQL APIs, similar to the Node.js workspace SDK but adapted for Python.\n\n## Features\n\n- \ud83d\ude80 **Async/await support** - Built with modern Python async patterns\n- \ud83d\udd10 **Authentication handling** - Token management and refresh logic\n- \ud83d\udce6 **Modular architecture** - Organized by feature modules\n- \ud83d\udd27 **Type hints** - Full typing support with mypy\n- \ud83e\uddea **Testing ready** - Pytest configuration included\n- \ud83d\udcda **Documentation** - Sphinx-ready documentation setup\n- \ud83d\udee0\ufe0f **Development tools** - Code formatting, linting, and pre-commit hooks\n\n## Installation\n\n```bash\n# Install from PyPI (when published)\npip install ggnomad-sdk\n\n# Or install in development mode\npip install -e .\n\n# Install with development dependencies\npip install -e \".[dev]\"\n```\n\n## Quick Start\n\n```python\nimport asyncio\nfrom ggnomad_sdk import BoilerSDK, BoilerSDKConfig\nfrom ggnomad_sdk.types.common import UserRegisterInput\n\nasync def main():\n # Initialize the SDK\n config = BoilerSDKConfig(\n endpoint=\"https://api.example.com/graphql\",\n api_key=\"your-api-key\" # Optional\n )\n \n sdk = BoilerSDK(config)\n \n try:\n # Register a new user\n user_input = UserRegisterInput(\n email=\"user@example.com\",\n name=\"John Doe\",\n password=\"secure_password\"\n )\n \n user = await sdk.auth.register(user_input)\n print(f\"User registered: {user.name}\")\n \n # Set authentication tokens\n sdk.set_tokens(\n access_token=\"your-access-token\",\n refresh_token=\"your-refresh-token\"\n )\n \n # Get current user\n current_user = await sdk.users.get_current_user()\n print(f\"Current user: {current_user.name}\")\n \n finally:\n await sdk.client.close()\n\n# Run the example\nasyncio.run(main())\n```\n\n## Configuration\n\nThe SDK is configured using the `BoilerSDKConfig` class:\n\n```python\nfrom ggnomad_sdk import BoilerSDKConfig\n\nconfig = BoilerSDKConfig(\n endpoint=\"https://api.example.com/graphql\", # Required\n api_key=\"your-api-key\", # Optional\n access_token=\"your-access-token\", # Optional\n refresh_token=\"your-refresh-token\", # Optional\n timeout=30.0 # Optional, default: 30.0\n)\n```\n\n## Available Modules\n\nThe SDK is organized into the following modules:\n\n- **auth** - Authentication operations (register, login, logout, etc.)\n- **user** - User management operations\n- **workspace** - Workspace operations (TODO)\n- **rbac** - Role-based access control (TODO)\n- **team** - Team management (TODO)\n- **project** - Project operations (TODO)\n- **resources** - Resource management (TODO)\n- **billing** - Billing operations (TODO)\n- **organization** - Organization management (TODO)\n- **payment** - Payment processing (TODO)\n- **quota** - Quota management (TODO)\n- **store** - Store operations (TODO)\n- **support** - Support ticket management (TODO)\n- **usage** - Usage analytics (TODO)\n- **utils** - Utility functions (TODO)\n- **addon** - Add-on management (TODO)\n- **plan** - Plan management (TODO)\n- **product** - Product management (TODO)\n- **config** - Configuration management (TODO)\n\n## Examples\n\nSee the `examples/` directory for more detailed usage examples:\n\n- `basic_usage.py` - Basic SDK operations\n- `advanced_usage.py` - Advanced features and error handling\n\n## Development\n\n### Setup Development Environment\n\n```bash\n# Clone the repository\ngit clone <repository-url>\ncd ggnomad-sdk-python\n\n# Create virtual environment\npython -m venv venv\nsource venv/bin/activate # On Windows: venv\\\\Scripts\\\\activate\n\n# Install development dependencies\npip install -e \".[dev]\"\n\n# Install pre-commit hooks\npre-commit install\n```\n\n### Code Quality\n\nThe project uses several tools for code quality:\n\n```bash\n# Format code\nblack src/ tests/ examples/\nisort src/ tests/ examples/\n\n# Lint code\nflake8 src/ tests/ examples/\nmypy src/\n\n# Run tests\npytest\n\n# Run tests with coverage\npytest --cov=ggnomad_sdk --cov-report=html\n```\n\n### Testing\n\n```bash\n# Run all tests\npytest\n\n# Run specific test file\npytest tests/test_auth.py\n\n# Run with coverage\npytest --cov=ggnomad_sdk\n\n# Run only unit tests\npytest -m unit\n\n# Run only integration tests\npytest -m integration\n```\n\n## Project Structure\n\n```\nggnomad-sdk-python/\n\u251c\u2500\u2500 src/\n\u2502 \u2514\u2500\u2500 ggnomad_sdk/\n\u2502 \u251c\u2500\u2500 __init__.py # Main SDK class\n\u2502 \u251c\u2500\u2500 client/ # HTTP/GraphQL client\n\u2502 \u251c\u2500\u2500 auth/ # Authentication module\n\u2502 \u251c\u2500\u2500 user/ # User management\n\u2502 \u251c\u2500\u2500 workspace/ # Workspace operations\n\u2502 \u251c\u2500\u2500 types/ # Type definitions\n\u2502 \u2514\u2500\u2500 ... # Other modules\n\u251c\u2500\u2500 tests/ # Test files\n\u251c\u2500\u2500 examples/ # Usage examples\n\u251c\u2500\u2500 docs/ # Documentation\n\u251c\u2500\u2500 pyproject.toml # Package configuration\n\u251c\u2500\u2500 requirements.txt # Production dependencies\n\u2514\u2500\u2500 requirements-dev.txt # Development dependencies\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature-name`\n3. Make your changes and add tests\n4. Run the test suite: `pytest`\n5. Commit your changes: `git commit -am 'Add feature'`\n6. Push to the branch: `git push origin feature-name`\n7. Create a Pull Request\n\n## Type Hints\n\nThis SDK is fully typed and supports mypy type checking:\n\n```bash\nmypy src/ggnomad_sdk\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for version history and changes.\n\n## Support\n\n- \ud83d\udcd6 **Documentation**: [docs.algoshred.com/sdk/python](https://docs.algoshred.com/sdk/python)\n- \ud83d\udc1b **Issues**: [GitHub Issues](https://github.com/algoshred/ggnomad-sdk-python/issues)\n- \ud83d\udcac **Discussions**: [GitHub Discussions](https://github.com/algoshred/ggnomad-sdk-python/discussions)\n\n## Related Projects\n\n- [Workspaces SDK Node.js](../workspaces-sdk-node) - The Node.js version this SDK is based on\n- [Boiler Frontend](../ggnomad-frontend) - Frontend ggnomad\n- [Boiler Backend](../ggnomad-python-be-graphql) - Python GraphQL backend ggnomad",
"bugtrack_url": null,
"license": "Copyright (c) 2025 Burdenoff Consultancy Services Private Limited, Algoshred Technologies Private Limited and all sister companies.\n \n All rights reserved.\n \n This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without the express written permission of the copyright holders.\n \n 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.\n \n For licensing inquiries, please contact: legal@algoshred.com",
"summary": "Python SDK for Boiler API - A GraphQL-based SDK for quick API integrations",
"version": "0.1.2a20251021152437",
"project_urls": {
"Changelog": "https://github.com/algoshred/ggnomad-sdk-python/blob/main/CHANGELOG.md",
"Documentation": "https://docs.algoshred.com/sdk/python",
"Homepage": "https://github.com/algoshred/ggnomad-sdk-python",
"Issues": "https://github.com/algoshred/ggnomad-sdk-python/issues",
"Repository": "https://github.com/algoshred/ggnomad-sdk-python"
},
"split_keywords": [
"algoshred",
" api-client",
" ggnomad",
" graphql",
" python",
" sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "48994c0715c891038f5cd2e3207936326f7be4402b0dd84bbd04ef9680aa8179",
"md5": "bf590fde05eae1c62499e174f1648b49",
"sha256": "5e381c9542e7eff10768c01129d2b259feddfb28d9df159c284b7678114d69ac"
},
"downloads": -1,
"filename": "ggnomad_sdk-0.1.2a20251021152437-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf590fde05eae1c62499e174f1648b49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21615,
"upload_time": "2025-10-21T15:24:48",
"upload_time_iso_8601": "2025-10-21T15:24:48.545715Z",
"url": "https://files.pythonhosted.org/packages/48/99/4c0715c891038f5cd2e3207936326f7be4402b0dd84bbd04ef9680aa8179/ggnomad_sdk-0.1.2a20251021152437-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "671327069800beb2e8591f1fff24f6cb82b07bf324ca6778868f9d4300802fc6",
"md5": "b3f52b5c9583ea9f907b2f83a7476418",
"sha256": "265d59a15a0743c579fec91a122f06dc1b080411824e08932caffcd4c3f0c6fb"
},
"downloads": -1,
"filename": "ggnomad_sdk-0.1.2a20251021152437.tar.gz",
"has_sig": false,
"md5_digest": "b3f52b5c9583ea9f907b2f83a7476418",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18214,
"upload_time": "2025-10-21T15:24:50",
"upload_time_iso_8601": "2025-10-21T15:24:50.013951Z",
"url": "https://files.pythonhosted.org/packages/67/13/27069800beb2e8591f1fff24f6cb82b07bf324ca6778868f9d4300802fc6/ggnomad_sdk-0.1.2a20251021152437.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-21 15:24:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "algoshred",
"github_project": "ggnomad-sdk-python",
"github_not_found": true,
"lcname": "ggnomad-sdk"
}
