GitLocker: The Coding Marketplace

Description:

magicalapi 1.1.1

MagicalAPI Python Client

An Async and Type Annotated Python Client to Easy Access MagicalAPI.com Service.

View Demo
·
Report Bug
·
Request Feature

Table of Contents

What is MagicalAPI

About The Project

Built With

Getting Started

Installation

Usage
Contributing
License

What is MagicalAPI?
MagicalAPI is your AI edge in content and careers, Your ultimate tool for YouTube SEO, Resume Parsing, LinkedIn data and more.

About The Project

This is a Python client that provides easy access to the MagicalAPI.com services, fully type annotated, and asynchronous.

(back to top)
Built With

(back to top)

Getting Started
This is an example of how you can install the client and use it in your own scripts and projects.
Installation
Install package using pip
pip install magicalapi

(back to top)

Usage
here are some samples of how to use the client for each service.
At first, you have to create an object of AsyncClient like this:
from magicalapi.client import AsyncClient

API_KEY = "mag_123456"
client = AsyncClient(api_key=API_KEY)

You can pass the API_KEY on the code, or put it on a .env file and the client will read from there.
Config .env File
Example of using .env file, all settings start with the prefix MAG_ and are case insensitive, so MAG_EXAMPLE, Mag_example, and mag_EXAMPLE are equal.
# .env

MAG_API_KEY="mag_1234567"

So now you can leave api_key parameter empty.
from magicalapi.client import AsyncClient

client = AsyncClinet()

Here is an example of how to get keywords of Youtube Top Keywords service:
import asyncio
from magicalapi.client import AsyncClient
from magicalapi.types.base import ErrorResponse

search_sentence = "chatgpt 4 turbo" # your search sentence to get keywords related to
country = "1" # use get_countries method to see countries codes (Default = 1 : WorlWide)
language = "1000" # use get_languages method to see countries codes (Default = 1000 : English)

async def main():
# the api_key will load from the .env file
async with AsyncClient() as client:
# Get YouTube keywords
keywords_response = await client.youtube_top_keywords.get_keywords(
search_sentence=search_sentence,
country=country,
language=language,
)
if type(keywords_response) == ErrorResponse:
# got error from API
print("Error :", keywords_response.message)
else:
# got response successfully
print("credits :", keywords_response.usage.credits)
print("keywords count :", len(keywords_response.data.keywords))

# save response in JSON file
with open("keywords_response.json", "w") as file:
file.write(keywords_response.model_dump_json(indent=3))

# get languages list
# languages = await client.youtube_top_keywords.get_languages()
# get countries list
# countries = await client.youtube_top_keywords.get_countries()

asyncio.run(main())

All of the methods in the client have type hints and help to simply use.
For full examples, please see the Examples Directory
(back to top)

Contributing
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Here is the Contributing Guidelines.
Don't forget to give the project a star! Thanks again!
(back to top)

License
Distributed under the MIT License. See LICENSE for more information.
(back to top)