# Curseforge API
[modrinth-api]: https://docs.modrinth.com/api-spec/
[cfapi-docs]: https://wow.curseforge.com/api/docs
[not-working-modrinth]: https://github.com/BetaPictoris/modrinth.py
[cmpdl]: https://github.com/Advik-B/CMPDL
This is a no-compromise CurseForge API wrapper for python. It is a re-write of [Modrinth.py][not-working-modrinth] which (In my opinion) is trash
This project is a complete re-write of the original project, with a focus on simplicity and ease of use.
This project is still in development, and is not yet ready for production use.
It also speeds up the process by using disk caching, It will cache the response from the API and will only make a new request if the request is not cached.
This, of course can be disabled by setting the cache to False.
## Features
- Simple and easy to use
- Caches responses from the API to disk for faster response times
- Allows direct access to the API via the `fetch` method
- Allows exporting of the objects to DICT, JSON, or YAML
## Installation
```bash
pip install modrinth-api
```
## TODO
- [ ] Implement the export methods
- [ ] Implement the cache
- [ ] Implement the fetch method
- [ ] Deal with the download URL being a null value
- [ ] Implement the search method
- [ ] Wrap the ENTIRE API
- [ ] Rename the classes so they have a `Rinth` prefix
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Advik-B/modrinth-api",
"name": "Modrinth-API",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "CMPDL,Minecraft,Modrinth,API,Wrapper",
"author": "Advik",
"author_email": "<advik.b@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4e/be/5d2c8643975a62bc72cc4e426759815f2966bfbe813dcd87aab477c883d5/Modrinth-API-0.0.1.tar.gz",
"platform": null,
"description": "\n# Curseforge API\n[modrinth-api]: https://docs.modrinth.com/api-spec/\n[cfapi-docs]: https://wow.curseforge.com/api/docs\n[not-working-modrinth]: https://github.com/BetaPictoris/modrinth.py\n[cmpdl]: https://github.com/Advik-B/CMPDL\n\nThis is a no-compromise CurseForge API wrapper for python. It is a re-write of [Modrinth.py][not-working-modrinth] which (In my opinion) is trash\nThis project is a complete re-write of the original project, with a focus on simplicity and ease of use.\n\nThis project is still in development, and is not yet ready for production use.\nIt also speeds up the process by using disk caching, It will cache the response from the API and will only make a new request if the request is not cached.\n\nThis, of course can be disabled by setting the cache to False.\n\n## Features\n- Simple and easy to use\n- Caches responses from the API to disk for faster response times\n- Allows direct access to the API via the `fetch` method\n- Allows exporting of the objects to DICT, JSON, or YAML\n\n## Installation\n\n```bash\npip install modrinth-api\n```\n\n## TODO\n- [ ] Implement the export methods\n- [ ] Implement the cache\n- [ ] Implement the fetch method\n- [ ] Deal with the download URL being a null value\n- [ ] Implement the search method\n- [ ] Wrap the ENTIRE API\n- [ ] Rename the classes so they have a `Rinth` prefix\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "",
"summary": "A no-compromises wrapper for the Modrinth API",
"version": "0.0.1",
"split_keywords": [
"cmpdl",
"minecraft",
"modrinth",
"api",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a19b0d2189016b6eb0603eba57d02612be1fbd44541f165758152072dc13558",
"md5": "dddb4b88c1b5831c4ed37d5e5f6714e5",
"sha256": "587eb4706924f225a9a3de303c2abc7b3dc3280a2bdd7ccd177aac11f682fffb"
},
"downloads": -1,
"filename": "Modrinth_API-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dddb4b88c1b5831c4ed37d5e5f6714e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2276,
"upload_time": "2023-01-24T14:59:17",
"upload_time_iso_8601": "2023-01-24T14:59:17.084065Z",
"url": "https://files.pythonhosted.org/packages/9a/19/b0d2189016b6eb0603eba57d02612be1fbd44541f165758152072dc13558/Modrinth_API-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ebe5d2c8643975a62bc72cc4e426759815f2966bfbe813dcd87aab477c883d5",
"md5": "c927cae8899af804353cd760027ac8bb",
"sha256": "36498c0d6043b477e26955d48bcc7bca434f9536c94d7f77971a20af369e5f58"
},
"downloads": -1,
"filename": "Modrinth-API-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c927cae8899af804353cd760027ac8bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2329,
"upload_time": "2023-01-24T14:59:19",
"upload_time_iso_8601": "2023-01-24T14:59:19.034709Z",
"url": "https://files.pythonhosted.org/packages/4e/be/5d2c8643975a62bc72cc4e426759815f2966bfbe813dcd87aab477c883d5/Modrinth-API-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-24 14:59:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Advik-B",
"github_project": "modrinth-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "modrinth-api"
}
JSON
