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-wrapper
    
  2. Use the wrapper in your Python script:

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: codewars_api_py-0.1.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-0.1.0.tar.gz
Algorithm Hash digest
SHA256 50765238a6cb862f685d5a04fa7a2ed7b78a8b3c195f638443de3067b55f0a90
MD5 597ec7bfe7f259d984cdc7e18ddac49a
BLAKE2b-256 eb0047907dedbd759de1b6e281ad6ee9fb7917c091a036102be76f9823a6b715

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for codewars_api_py-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 efb8a440988640783614be152f92c5c7f066d4045d4dee0678fc5e34b5998e97
MD5 4e60c8171fcfa78c63ebee6ca2a00163
BLAKE2b-256 6fefcd59934adb3c3732764fec9ddb54fb91d447bea784adb5bb303dec7b754a

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