Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yisuschrist/codewars-api-py
Effortlessly interact with Codewars API using a Python wrapper
https://github.com/yisuschrist/codewars-api-py
api codewars codewars-api python
Last synced: about 11 hours ago
JSON representation
Effortlessly interact with Codewars API using a Python wrapper
- Host: GitHub
- URL: https://github.com/yisuschrist/codewars-api-py
- Owner: YisusChrist
- License: gpl-3.0
- Created: 2023-11-16T00:50:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-12T17:13:49.000Z (8 days ago)
- Last Synced: 2024-11-12T18:24:50.712Z (7 days ago)
- Topics: api, codewars, codewars-api, python
- Language: Python
- Homepage: https://pypi.org/project/codewars-api-py
- Size: 241 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](#features)
- [Getting Started](#getting-started)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## 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:
```bash
pip install codewars-api-py
```
2. Use the wrapper in your Python script:
```python
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](https://dev.codewars.com).
## Contributing
Contributions are welcome! Please check the [Contributing Guidelines](https://github.com/YisusChrist/.github/blob/main/CONTRIBUTING.md) for more details.
## License
This project is licensed under the GPL V3 License - see the [LICENSE](LICENSE) file for details.