Skip to main content

Effortlessly interact with Codewars API using a Python wrapper

Project description

            Tests Passing    GitHub pull requests    License

Alt

Effortlessly interact with the Codewars API using this Python wrapper. Simplify user, challenge, and leaderboard data retrieval, making integration seamless for your projects.

Table of Contents

Features

  • User Information: Retrieve detailed user information including username, honor, skills, ranks, and completed challenges.
  • Completed Challenges: Get a list of challenges completed by a user, including details like challenge name, completion date, and programming languages used.
  • Authored Challenges: List challenges authored by a specific user with information on ranks, tags, and available languages.
  • Code Challenge Details: Obtain detailed information about a specific code challenge, including its name, description, tags, and user statistics.

Getting Started

  1. Install the package:

    pip install codewars-api-py
    
  2. Use the wrapper in your Python script:

    from codewars_api_py import CodewarsAPI
    
    # Initialize the Codewars API wrapper
    codewars_api = CodewarsAPI()
    
    # Example: Get user information
    user_info = codewars_api.get_user("some_user")
    print(user_info)
    
    # Example: List completed challenges
    completed_challenges = codewars_api.list_completed_challenges("some_user")
    print(completed_challenges)
    

Documentation

For detailed information on available methods and usage, refer to the Codewars API Wrapper Documentation.

Contributing

Contributions are welcome! Please check the Contributing Guidelines for more details.

License

This project is licensed under the GPL V3 License - see the LICENSE file for details.

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

codewars_api_py-1.0.1.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

codewars_api_py-1.0.1-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file codewars_api_py-1.0.1.tar.gz.

File metadata

  • Download URL: codewars_api_py-1.0.1.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.4 Windows/10

File hashes

Hashes for codewars_api_py-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3d976770cec4b04fac55138712612355dd2cd8d8f72f24140fcba2a00544796b
MD5 88f5a763b881ea10439b9e15fe44a819
BLAKE2b-256 537064dab92ad0f86fb76f482eee06812e572f5d61c728edd833c534b22b57f6

See more details on using hashes here.

File details

Details for the file codewars_api_py-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for codewars_api_py-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 21819b43f3ae164d799e70c5de5c89abc207122bb9e54bdde7c99adccaa78e15
MD5 6e401c96241cf99d796902673d799cb6
BLAKE2b-256 a6c0591eb2981a7595c06c613771ea8da34d4ec4c72b4b27129ad90aca28d565

See more details on using hashes here.

Supported by

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