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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file mvsma-1.0.2.tar.gz.

File metadata

  • Download URL: mvsma-1.0.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for mvsma-1.0.2.tar.gz
Algorithm Hash digest
SHA256 ab22872abce618c19dc435e967229e12a2de20c3dfa76dec283270b7444145c4
MD5 531eb581376fdd849589475d105c85a2
BLAKE2b-256 937defca543d9b89d96292b4325001b234f32a09d6038c7ecc6eb4695596d344

See more details on using hashes here.

Provenance

File details

Details for the file mvsma-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: mvsma-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for mvsma-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6196bfafc61d37b5739a38a86eb4c00b7ebeb317a8c1eb1f90ab5cd98fe445a1
MD5 348c4db7f8e82b0605d19617f1390dd7
BLAKE2b-256 7702a5b0e40bbe3f8cd06ea159c94d3edc9f6ee6e1ee8f644d5983b82cf2299e

See more details on using hashes here.

Provenance

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