Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 3.39 KB

README.md

File metadata and controls

79 lines (58 loc) · 3.39 KB
Raw

            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.