Unofficial Python SDK for Magalu Cloud
Project description
MGC SDK for Python
An unofficial, open-source Python SDK for interacting with the Magalu Cloud API.
This project aims to provide a Pythonic and developer-friendly interface for Magalu Cloud services, inspired by the official Go SDK while remaining completely independent from Magalu Cloud and its maintainers. The project is community-driven and maintained by contributors.
Disclaimer
This is an unofficial SDK and is not affiliated with, endorsed by, or maintained by Magalu Cloud. For the official SDKs and tools, visit the Magalu Cloud GitHub organization.
Features
- Pythonic API design
- Async support using
httpx - Typed Python interfaces
- Modular service architecture
- Easy authentication using API keys
- Open-source and community-driven
- Designed for automation, scripting, and backend applications
Installation
Using pip
pip install mgc-sdk-python
Using uv
uv add mgc-sdk-python
Development installation
git clone https://github.com/kayqueGovetri/mgc-sdk-python.git
cd mgc-sdk-python
make sync-dev
Quick Start
import asyncio
from mgc.client import Client
async def main() -> None:
async with Client(api_key="YOUR_API_KEY") as client:
virtual_machines = await client.compute.virtual_machines.list()
print(virtual_machines)
if __name__ == "__main__":
asyncio.run(main())
Authentication
The SDK authenticates requests with a Magalu Cloud API key. Pass the key when creating the client:
from mgc.client import Client
client = Client(
api_key="YOUR_API_KEY"
)
Supported Services
Current implementation status:
Compute
- Virtual Machines
- Images
- Machine Types
- Snapshots
- Backups
Block Storage
- Volumes
- Snapshots
- Volume type lookup
Networking
- VPCs
- Subnets
- Security Groups
- Public IPs
Kubernetes
- Clusters
- Node Pools
Database
- DBaaS Instances
- Replicas
- Snapshots
The roadmap evolves based on community contributions and API availability.
Project Structure
mgc-sdk-python/
├── examples/
│ ├── block_storage/
│ │ ├── snapshot/
│ │ └── volume/
│ └── compute/
│ ├── backup/
│ ├── images/
│ ├── snapshot/
│ └── virtual_machine/
├── src/
│ └── mgc/
│ ├── resources/
│ │ ├── block_storage/
│ │ │ ├── block_storage.py
│ │ │ ├── snapshots.py
│ │ │ └── volumes.py
│ │ └── compute/
│ │ ├── backups.py
│ │ ├── compute.py
│ │ ├── images.py
│ │ ├── machine_types.py
│ │ ├── snapshots.py
│ │ └── virtual_machines.py
│ ├── __init__.py
│ ├── auth.py
│ ├── client.py
│ ├── config.py
│ ├── exceptions.py
│ ├── region.py
│ └── transport.py
├── tests/
│ ├── resources/
│ │ ├── block_storage/
│ │ └── compute/
│ ├── conftest.py
│ ├── test_client.py
│ ├── test_config.py
│ ├── test_region.py
│ └── test_transport.py
├── LICENSE
├── Makefile
├── pyproject.toml
├── README.md
Why This Project?
While Magalu Cloud provides official tooling and SDKs, Python developers may prefer a native Python experience for:
- Automation
- Infrastructure management
- Data engineering
- Backend services
- Serverless applications
- Scripts and CLI tools
This project seeks to fill that gap with a modern Python SDK.
Contributing
Contributions are welcome.
You can contribute by:
- Reporting bugs
- Suggesting new features
- Improving documentation
- Adding support for new services
- Writing tests
Running tests
make test
Linting
make lint
Formatting check
make ruff-format-check
Roadmap
- Full Compute API coverage
- Networking support
- Kubernetes support
- DBaaS support
- Object Storage support
- CLI integration
- Complete documentation
- Automated releases
Related Projects
- Official Magalu Cloud Go SDK
- Official Magalu Cloud Organization
See the LICENSE file for details.
Built and maintained by the open-source community.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mgc_sdk_python-0.0.2.tar.gz.
File metadata
- Download URL: mgc_sdk_python-0.0.2.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
60ac957114fe1082a3cd67524187036f50cab86775bf409fc55dc43b57af1018
|
|
| MD5 |
198a4049e30973513588aa269f6b1e9a
|
|
| BLAKE2b-256 |
d49c51b94a218aaeb420292e37168369e817d26bc533f928e4caeca05dcfda02
|
Provenance
The following attestation bundles were made for mgc_sdk_python-0.0.2.tar.gz:
Publisher:
publish.yml on kayqueGovetri/mgc-sdk-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mgc_sdk_python-0.0.2.tar.gz -
Subject digest:
60ac957114fe1082a3cd67524187036f50cab86775bf409fc55dc43b57af1018 - Sigstore transparency entry: 2164887198
- Sigstore integration time:
-
Permalink:
kayqueGovetri/mgc-sdk-python@9df4d448486f02e208ece9f67aa572921ef1395d -
Branch / Tag:
refs/tags/v0.0.2 - Owner: https://github.com/kayqueGovetri
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9df4d448486f02e208ece9f67aa572921ef1395d -
Trigger Event:
release
-
Statement type:
File details
Details for the file mgc_sdk_python-0.0.2-py3-none-any.whl.
File metadata
- Download URL: mgc_sdk_python-0.0.2-py3-none-any.whl
- Upload date:
- Size: 19.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1e7ae1b38c26d7217e5a8cdb6932421533429bd606e225e1adbfd79aede17c20
|
|
| MD5 |
2bb932a73774f9e765480e3066fbd3d2
|
|
| BLAKE2b-256 |
8ba7b63b244a89fe598556777fc57a014a3b36af8e2e2916b3a372ea50b30170
|
Provenance
The following attestation bundles were made for mgc_sdk_python-0.0.2-py3-none-any.whl:
Publisher:
publish.yml on kayqueGovetri/mgc-sdk-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mgc_sdk_python-0.0.2-py3-none-any.whl -
Subject digest:
1e7ae1b38c26d7217e5a8cdb6932421533429bd606e225e1adbfd79aede17c20 - Sigstore transparency entry: 2164887239
- Sigstore integration time:
-
Permalink:
kayqueGovetri/mgc-sdk-python@9df4d448486f02e208ece9f67aa572921ef1395d -
Branch / Tag:
refs/tags/v0.0.2 - Owner: https://github.com/kayqueGovetri
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9df4d448486f02e208ece9f67aa572921ef1395d -
Trigger Event:
release
-
Statement type: