Unable to verify the project's public source code repository.

Package Health Score

54 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Popularity

Limited

GitHub Stars: ?
Forks: ?
Contributors: -

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package matrix-roomba, we found that it has been starred ? times.

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 27, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Copyright (c) 2024 Private.coffee Team <support@private.coffee> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Security Policy

We found a way for you to contribute to the project! Looks like matrix-roomba is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Unavailable commit data

Open Issues: ?
Open PR: ?
Last Release: 3 months ago
Last Commit: unknown

Further analysis of the maintenance status of matrix-roomba based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that matrix-roomba demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.10

Age: 3 months
Latest Release: 3 months ago
Dependencies: 2 Direct
Versions: 3
Maintainers: 1
Wheels: OS Independent

Readme

Matrix-Roomba

Roomba is a moderation bot for Matrix, designed to help manage rooms and enforce content policies. The bot can block/unblock rooms, shut down rooms, and notify users of shutdowns. It integrates with Synapse's administrative API and supports optional encryption through Pantalaimon.

Installation

pip install matrix-roomba

Create a configuration file in config.yaml based on the config.dist.yaml provided in the repository.

At the very least, you need to provide the following configuration:

homeserver: "https://matrix.example.com"
user_id: "@roomba:example.com"
access_token: "YOUR_ACCESS_TOKEN"
moderation_room_id: "!moderation_room_id:example.com"

Ensure that the bot user is an admin on the homeserver, as it needs to be able to moderate rooms. Also add the user to the moderation room before starting the bot.

We recommend using pantalaimon as a proxy, because the bot itself does not support end-to-end encryption.

You can start the bot by running:

Usage

Start the bot:

roomba

Send a message to the moderation room to get a list of available commands:

!roomba

Commands

In the moderation room, send commands to manage rooms:

Block a room: !roomba block
Unblock a room: !roomba unblock
Shutdown a room: !roomba shutdown [--purge]
For help: !roomba

License

This project is licensed under the MIT License - see the LICENSE file for details.

matrix-roomba dependencies

matrix-nio pyyaml

FAQs

What is matrix-roomba?

A Matrix bot that helps you shut down rooms. Visit Snyk Advisor to see a full health score report for matrix-roomba, including popularity, security, maintenance & community analysis.

Is matrix-roomba popular?

We’re still processing downloads data for the python package matrix-roomba. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is matrix-roomba safe to use?

The python package matrix-roomba was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 27 November-2024, at 05:22 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

matrix-roomba

A Matrix bot that helps you shut down rooms For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Matrix-Roomba

Installation

Usage

Commands

License

matrix-roomba dependencies

FAQs

What is matrix-roomba?

Is matrix-roomba popular?

Is matrix-roomba safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Matrix-Roomba

Installation

Usage

Commands

License

matrix-roomba dependencies

FAQs

What is matrix-roomba?

Is matrix-roomba popular?

Is matrix-roomba safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues