python-modrinth 1.2.1

A Python library that interacts with the Modrinth API

Pyrinth

Interacts with the Modrinth API
Explore the docs »

Report Bug · Request Feature

Getting Started

Prerequisites

To use Pyrinth you need the following:

• Python
• pip (Comes with Python)

Installation

Automatic Installation

To automatically install the latest version of Pyrinth, run this command in the terminal:

pip install python-modrinth

---

Manual Installation

If you want to get the latest beta or pre-releases, follow the steps below:

1. Go to the releases page and download one of the .whl files.
2. Open a terminal and go to the downloads directory.
3. Type this: pip install pyrinth, then press tab and it should autocomplete.

Issues

If you find a bug, please check if the issue already exists, otherwise open an issue through this link.

Contributing

Creating A Fork And Pull Request

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Using Pyrinth Source Code

When you're using the Pyrinth source code, navigate to the src directory and create your main Python file.

License

This project is distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/RevolvingMadness/Pyrinth Discord Server: Coming Soon!

To-Do

• Projects
  • Search Projects
  • Get a project
  • Modify a project
  • Delete a project
  • Get multiple projects
  • Edit multiple projects
  • Get a list of random projects
  • Create a project
  • Change project's icon
  • Delete projcet's icon
  • Check project slug/ID validity
  • Add a gallery image
  • Modify a gallery image
  • Delete a gallery image
  • Get all of a project's dependencies
  • Follow a project
  • Unfollow a project
  • Schedule a project
• Versions
  • List project's versions
  • Get a version
  • Modify a version
  • Delete a version
  • Create a version
  • Schedule a version
  • Get multipe versions
  • Add files to version
• Version Files
  • Get version from hash
  • Delete a file from its hash
  • Latest version of a project from a has, loader(s), and game version(s)
  • Get versions from hashes
  • Latest versions multiple project from hashes, loader(s), and game version(s)
• Users - Complete
  • Get a user
  • Modify a user
  • Delete a user
  • Get user from authorization header
  • Get multiple users
  • Change user's avatar
  • Get user's projects
  • Get user's notifications
  • Get user's followed projects
  • Get user's payout history
  • Withdraw payout balance to PayPal or Venmo
• Teams
  • Get a project's team members
  • Get a team's members
  • Add a user to a team
  • Get the members of multiple teams
  • Join a team
  • Modify a team member's information
  • Remove a team member from a team
  • Transfer team's ownership to another user
• Tags - Complete
  • Get a list of categories
  • Get a list of loaders
  • Get a list of game versions
  • Get a list of licenses
  • Get a list of donation platforms
  • Get a list of report types
• Miscellaneous
  • Report a project, user, or version
  • Various statistics about this Modrinth instance

Documentation

You can find the documentation here