cool-magic-admin


Namecool-magic-admin JSON
Version 1.2.1 PyPI version JSON
download
home_pagehttps://magic.link
SummaryMagic Python Library Revised to support python versions 3.9 and above.
upload_time2024-04-17 02:33:42
maintainerNone
docs_urlNone
authorMagic
requires_python>=3.7
licenseMIT
keywords magic python sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Revisited Magic Admin Python SDK

The (Cool) Magic Admin Python SDK provides convenient ways for developers to interact with Magic API endpoints and an array of utilities to handle [DID Token](https://magic.link/docs/auth/introduction/decentralized-id).

This package has been revisited from the original to support newer versions of python.

## Table of Contents

* [Documentation](#documentation)
* [Quick Start](#quick-start)
* [Development](#development)
* [Changelog](#changelog)
* [License](#license)

## Documentation
See the [Magic doc](https://magic.link/docs/auth/api-reference/server-side-sdks/python)!

## Installation
You can directly install the SDK with:

pip:

```
pip install cool-magic-admin
```


### Prerequisites

- Python 3.9+


## Quick Start
Before you start, you will need an API secret key. You can get one from the [Magic Dashboard](https://dashboard.magic.link/). Once you have the API secret key, you can instantiate a Magic object.

```
from magic_admin import Magic

magic = Magic(api_secret_key='<YOUR_API_SECRET_KEY>')

magic.Token.validate('DID_TOKEN')

# Read the docs to learn more! 🚀
```

Optionally if you would like, you can load the API secret key from the environment variable, `MAGIC_API_SECRET_KEY`.

```
# Set the env variable `MAGIC_API_SECRET_KEY`.

magic = Magic()
```

**Note**: The argument passed to the `Magic(...)` object takes precedence over the environment variable.

### Configure Network Strategy
The `Magic` object also takes in `retries`, `timeout` and `backoff_factor` as optional arguments at the object instantiation time so you can override those values for your application setup.

```
magic = Magic(retries=5, timeout=10, backoff_factor=0.03)
```

## Development
We would love to have you contributing to this SDK. To get started, you can clone this repository and create a virtualenv.

```
make development
```

This will create a virtualenv for all the local development dependencies that the SDK will needs.

Once it is done, you can `source` the virtualenv. It makes your local development easier!

```
source virtualenv_run/bin/activate
```

To make sure your new code works with the existing SDK, run the test against the current supported Python versions.

```
make test
```

To clean up existing virtualenv, tox log and pytest cache, do a

```
make clean
```

This repository is installed with [pre-commit](https://pre-commit.com/). All of the pre-commit hooks are run automatically with every new commit. This is to keep the codebase styling and format consistent.

You can also run the pre-commit manually. You can find all the pre-commit hooks [here](.pre-commit-config.yaml).

```
pre-commit run
```

Please also see our [CONTRIBUTING](CONTRIBUTING.md) guide for other information.

## Changelog
See [Changelog](CHANGELOG.md)

## License
See [License](LICENSE.txt)

Raw data

            {
    "_id": null,
    "home_page": "https://magic.link",
    "name": "cool-magic-admin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "magic python sdk",
    "author": "Magic",
    "author_email": "support@magic.link",
    "download_url": "https://files.pythonhosted.org/packages/e0/13/c4aa5d709d9b0c6bca82366b60984604b84bb33a0178bfaf66311e234f94/cool_magic_admin-1.2.1.tar.gz",
    "platform": null,
    "description": "# Revisited Magic Admin Python SDK\n\nThe (Cool) Magic Admin Python SDK provides convenient ways for developers to interact with Magic API endpoints and an array of utilities to handle [DID Token](https://magic.link/docs/auth/introduction/decentralized-id).\n\nThis package has been revisited from the original to support newer versions of python.\n\n## Table of Contents\n\n* [Documentation](#documentation)\n* [Quick Start](#quick-start)\n* [Development](#development)\n* [Changelog](#changelog)\n* [License](#license)\n\n## Documentation\nSee the [Magic doc](https://magic.link/docs/auth/api-reference/server-side-sdks/python)!\n\n## Installation\nYou can directly install the SDK with:\n\npip:\n\n```\npip install cool-magic-admin\n```\n\n\n### Prerequisites\n\n- Python 3.9+\n\n\n## Quick Start\nBefore you start, you will need an API secret key. You can get one from the [Magic Dashboard](https://dashboard.magic.link/). Once you have the API secret key, you can instantiate a Magic object.\n\n```\nfrom magic_admin import Magic\n\nmagic = Magic(api_secret_key='<YOUR_API_SECRET_KEY>')\n\nmagic.Token.validate('DID_TOKEN')\n\n# Read the docs to learn more! \ud83d\ude80\n```\n\nOptionally if you would like, you can load the API secret key from the environment variable, `MAGIC_API_SECRET_KEY`.\n\n```\n# Set the env variable `MAGIC_API_SECRET_KEY`.\n\nmagic = Magic()\n```\n\n**Note**: The argument passed to the `Magic(...)` object takes precedence over the environment variable.\n\n### Configure Network Strategy\nThe `Magic` object also takes in `retries`, `timeout` and `backoff_factor` as optional arguments at the object instantiation time so you can override those values for your application setup.\n\n```\nmagic = Magic(retries=5, timeout=10, backoff_factor=0.03)\n```\n\n## Development\nWe would love to have you contributing to this SDK. To get started, you can clone this repository and create a virtualenv.\n\n```\nmake development\n```\n\nThis will create a virtualenv for all the local development dependencies that the SDK will needs.\n\nOnce it is done, you can `source` the virtualenv. It makes your local development easier!\n\n```\nsource virtualenv_run/bin/activate\n```\n\nTo make sure your new code works with the existing SDK, run the test against the current supported Python versions.\n\n```\nmake test\n```\n\nTo clean up existing virtualenv, tox log and pytest cache, do a\n\n```\nmake clean\n```\n\nThis repository is installed with [pre-commit](https://pre-commit.com/). All of the pre-commit hooks are run automatically with every new commit. This is to keep the codebase styling and format consistent.\n\nYou can also run the pre-commit manually. You can find all the pre-commit hooks [here](.pre-commit-config.yaml).\n\n```\npre-commit run\n```\n\nPlease also see our [CONTRIBUTING](CONTRIBUTING.md) guide for other information.\n\n## Changelog\nSee [Changelog](CHANGELOG.md)\n\n## License\nSee [License](LICENSE.txt)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Magic Python Library Revised to support python versions 3.9 and above.",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://magic.link",
        "Website": "https://magic.link"
    },
    "split_keywords": [
        "magic",
        "python",
        "sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc25eb49d6433472c749147ddeaddf116cadf84b3a8237b36f5703ffa36a6c59",
                "md5": "c10d92f16d8566fca1824000d0a963ab",
                "sha256": "98605626e555461c859ff3cbbd153aadf0f785b04f2fcf8e3a45ed4676c86d26"
            },
            "downloads": -1,
            "filename": "cool_magic_admin-1.2.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c10d92f16d8566fca1824000d0a963ab",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 12738,
            "upload_time": "2024-04-17T02:33:40",
            "upload_time_iso_8601": "2024-04-17T02:33:40.999648Z",
            "url": "https://files.pythonhosted.org/packages/bc/25/eb49d6433472c749147ddeaddf116cadf84b3a8237b36f5703ffa36a6c59/cool_magic_admin-1.2.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e013c4aa5d709d9b0c6bca82366b60984604b84bb33a0178bfaf66311e234f94",
                "md5": "3eb084f375876d76a699ae910683db2e",
                "sha256": "21c323585be6832e2ecf58cdaebd0db1b8a5c46878c934b28ad308049192bd47"
            },
            "downloads": -1,
            "filename": "cool_magic_admin-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3eb084f375876d76a699ae910683db2e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 9718,
            "upload_time": "2024-04-17T02:33:42",
            "upload_time_iso_8601": "2024-04-17T02:33:42.034621Z",
            "url": "https://files.pythonhosted.org/packages/e0/13/c4aa5d709d9b0c6bca82366b60984604b84bb33a0178bfaf66311e234f94/cool_magic_admin-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-17 02:33:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cool-magic-admin"
}
Magic
Elapsed time: 0.24354s