Skip to main content

Wrapper for Primordial API

Project description

🌌 Primordial API Wrapper

Primordial API Wrapper is a Python package that provides a sleek and powerful interface to interact with the Primordial API. This wrapper makes API calls a breeze and handles responses like a pro! 🚀

🛠️ Installation

Get the Primordial API Wrapper up and running with a simple pip command:

pip install primordial-wrapper

🚀 Usage

To harness the power of the Primordial API Wrapper, import the PrimordialAPI class and initialize it with your API key:

from primordial_wrapper import PrimordialAPI

api = PrimordialAPI(api_key="your_api_key")

🧰 Available Methods

The wrapper comes packed with these awesome methods:

  1. 🤖 generate_ai_response(prompt: str): Get an AI-generated response
  2. 🎨 generate_ai_image(prompt: str): Create an AI-generated image
  3. 📥 download_media(url: str): Download media from a URL
  4. 📋 create_pastebin(content: str): Create a new pastebin entry
  5. 🔍 get_pastebin(pastebin_id: str): Fetch a pastebin entry
  6. ☀️ get_weather(city: str): Get weather info for a city
  7. 🗣️ text_to_speech(text: str, lang: str = 'en'): Convert text to speech
  8. 📱 generate_qr(url: str): Generate a QR code
  9. 🔗 shorten_url(url: str): Shorten a URL
  10. 🚧 bypass_link(url: str): Bypass shortened links
  11. 📊 get_bf_stock(): Get Blox Fruits stock info
  12. 🕷️ scrape_web(url: str): Scrape a website
  13. 📤 upload_image(image_path: str): Upload an image
  14. 🖼️ get_image(image_id: str): Retrieve an image

💡 Example

Here's a quick example to get you started:

from primordial_wrapper import PrimordialAPI
api = PrimordialAPI(api_key="your_api_key_here")
response = api.generate_ai_response("Tell me a joke about programming")
print(response)

👨‍💻 Development

Set up your dev environment in a flash:

  1. Clone the repo:

    git clone https://github.com/KirbyHacks/primordial-wrapper.git
    cd primordial-wrapper
    
  2. Install in editable mode with dev dependencies:

    pip install -e .[dev]
    
  3. Run those tests:

    pytest
    

🤝 Contributing

We love contributions! Here's how you can help:

  1. 🍴 Fork the repository
  2. 🌿 Create a new branch for your feature or bug fix
  3. 🛠️ Make your changes and write tests if applicable
  4. ✅ Run the tests to ensure everything's working
  5. 📤 Submit a pull request with a clear description of your changes

📜 License

This project is licensed under the MIT License. Check out the LICENSE file for all the legal stuff.

📬 Contact

Got questions? We've got answers!

For any other issues, feel free to open an issue on the GitHub repository.

Happy coding! 🎉

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

primordial_wrapper-1.2.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

primordial_wrapper-1.2.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file primordial_wrapper-1.2.0.tar.gz.

File metadata

  • Download URL: primordial_wrapper-1.2.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for primordial_wrapper-1.2.0.tar.gz
Algorithm Hash digest
SHA256 e6c7f175f346d971fc0812573dc4d2d6fbd3ddbae568c104005df7842a4c0bad
MD5 4a0a057bc3c002ffd551a6346b3ede80
BLAKE2b-256 82706332148ff3632d841eee032768d699ed8e5860816fcd4b3f400c23417cd4

See more details on using hashes here.

File details

Details for the file primordial_wrapper-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for primordial_wrapper-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ac095771cf9952a1e562805c11b9bbbc7411d22916e9c80de869cb5a58b3a41
MD5 c4ada03249fb682f8b7f5c529b43d35a
BLAKE2b-256 8e39fcd780ebc311af91194a9dc21208e324662e1b07c36bf1edbb7228f60a58

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page