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-0.1.1.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

codewars_api_py-0.1.1-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codewars_api_py-0.1.1.tar.gz
  • Upload date:
  • Size: 19.5 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-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1477059bb41be4ae3a475d9d8c564493afbf957bfd1b46fc8c196f2d1789bf14
MD5 aa89050199b92c300c8249f42c247d96
BLAKE2b-256 ca4551bc6eafe5cce7177bf1f8d1e7b5beb525ec6f81b49741174f6acd64c9f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for codewars_api_py-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 969fa677f519174b3d960ad43cd767a671e7f9b6f0824a788a869e2e884c831a
MD5 8b3a25a0a68e2981642fd2196408acc2
BLAKE2b-256 67712a3671d95babccdf402aa474f189e8862d9b5eff4ded0ab2e1942997dd7f

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