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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: codewars_api_py-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 c852bb12c6affef92535fb9b80445245e9d3375b55e2c104ff487c1478caf361
MD5 26865caa9eea983f487279e33cc676d0
BLAKE2b-256 7875c706493367cd5cbf1038ac142c261ce88a3691d6c172e3c44c70078c4649

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for codewars_api_py-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 56e052e92cecb75dc74744220ead986ebff5b850a0c5556f998a115a65d58c89
MD5 923152752f69784b48495152f1f009de
BLAKE2b-256 d39a70f73bd086480d1aec159fe8d52b67b35a9de7d9c1d0ae59efbd743d9a25

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