Download the PHP package rikudou/lemmy-api without Composer
On this page you can find all versions of the php package rikudou/lemmy-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package lemmy-api
Lemmy API
Lemmy is all the rage now! This package allows you to communicate with Lemmy from PHP which opens up great possibilities for writing bots!
All methods are fully typed so your IDE should help you a lot.
Note that this is an alpha version and while everything should work, the public api will probably change as I find better names and/or locations for various methods.
Installation
Requires PHP 8.2.
composer require rikudou/lemmy-api
You also need to install a compatible PSR http client and PSR http request factory:
composer require rikudou/lemmy-api guzzlehttp/guzzle
or
composer require rikudou/lemmy-api symfony/http-client nyholm/psr7
or any other implementation you like.
Usage
Notes
There are many, many api methods, most of them have no documentation in the upstream so I tried my best to guess at what they do and tried to sort them into different classes, I'm not entirely sure if I managed to do so correctly.
Due to the same reason it would also be hard to list them all and provide documentation, it would easily take me more time than writing the code. If someone feels up to the task, I'll gladly accept PRs with documentation!
To get you started at least a little, check the various interfaces to see the names and arguments of methods:
- LemmyApi - the main class, contains links to other modules and two api methods on its own,
login()andregister() - AdminEndpoint - contains methods that only instance admins can use
- CommentEndpoint - contains stuff relating to comments, like posting, editing, deleting and so on
- CommunityEndpoint - contains stuff relating to communities, creating, deleting, listing etc.
- CurrentUserEndpoint - contains stuff relating to the currently logged in user
- MiscellaneousEndpoint - stuff that doesn't belong in any other category
- ModeratorEndpoint - stuff that only moderators can do
- PostEndpoint - methods relating to posts
- SiteEndpoint - methods relating to the instance itself
- UserEndpoint - methods relating to users in general
Currently even api calls that don't need a logged in user require login in this package, meaning this package doesn't allow anonymous access at all. This will be looked into in the future.
There are no tests currently, I plan them in the future but now I don't want to see anything Lemmy api related for a while.
Example
A very primitive remind me bot:
All versions of lemmy-api with dependencies
psr/http-factory Version ^1.0
psr/http-factory-implementation Version *
psr/http-client-implementation Version *
php Version ^8.2
ext-json Version *
psr/http-message Version ^1.0 | ^2.0
ext-fileinfo Version *