Skip to main content

Super simple modrinth api wrapper for python

Project description

mvsma

mvsma, aka mhamster's very simple modrinth api (wrapper), is a super simple modrinth api wrapper for python.

Package provides plain and simple access to modrinth's api endpoints and returns json responses. Very easy to use!

For information about api models see modrinth api documentation.

But why?


Because why would you want to mess with api yourself, when some random guy from internet (like me) can do it for you?

Issues and contributions

Want to improve this project? Feel free to create forks and/or pull requests!

Something does not work as intended? Feel free to open issue and describe what actually went wrong.


Examples

Search for a projects:

from mvsma import Modrinth

m = Modrinth()
# Search for mod called 'cesium' and print first result
m.ua = 'Package example from https://github.com/mhamsterr/mvsma' # Edit User-Agent of request so everyone will know who we are and what we are doing

response = m.search(query="cesium")
print(response["hits"][0])

Get versions of a project:

from mvsma import Modrinth

m = Modrinth()
# Get versions of mod with slug "supercoolmod"
m.ua = 'Package example from https://github.com/mhamsterr/mvsma' # Edit User-Agent of request so everyone will know who we are and what we are doing

response = m.project_versions(slug="supercoolmod")
print(response)

Get list of random projects

from mvsma import Modrinth

m = Modrinth()
# Get list of random projects
m.ua = 'Package example from https://github.com/mhamsterr/mvsma' # Edit User-Agent of request so everyone will know who we are and what we are doing

response = m.random_projects(count=11)
print(response)

Installation

pip install mvsma

Documentation:

TODO

License:

MIT License, find more in 'LICENSE' file

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

mvsma-1.0.2.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

mvsma-1.0.2-py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 3

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