Package Health Score

70 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Active

Explore Similar Packages

wasabi
85

Popularity

Small

GitHub Stars: 8.64K
Forks: 1.81K
Contributors: 140

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package cubicweb-s3storage, we found that it has been starred 8,637 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Feb 26, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
16
M
0
L

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

License

Apache-2.0

Security Policy

Yes

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

Open Issues: 185
Open PR: 14
Last Release: 4 months ago
Last Commit: 4 months ago

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

We found that cubicweb-s3storage demonstrates a positive version release cadence with at least one new version released in the past 12 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

Active

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

A good and healthy external contribution signal for cubicweb-s3storage project, which invites more than one hundred open source maintainers to collaborate on the repository.

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: Unspecified

Age: 4 years
Latest Release: 4 months ago
Dependencies: 2 Direct / 44 Total
Versions: 16
Maintainers: 1
Wheels: OS Independent

Readme

Summary

A Cubicweb Storage that stores the data on S3.

It is a standard Cubicweb Storage, similar to the BytesFileSystemStorage. For example, if you want to store File.data payloads in S3, you should create an S3Storage instance, typically in a startup hook, as:

from cubicweb.server.hook import Hook
from cubicweb_s3storage.storages import S3Storage

class S3StorageStartupHook(Hook):
    __regid__ = 'mycube.server-startup-hook'
    events = ('server_startup', 'server_maintenance')

    def __call__(self):
        storage = S3Storage('s3_bucket')
        self.repo.system_source.set_storage('File', 'data', storage)

By default, S3 object keys (ie. S3 object identifiers) are random UUID generated at entity creation time. If you want to implement another key generation algorithm, you must write overload S3Storage.new_s3_key() method.

Communications with AWS are handled by boto3.

Warning

There is no cache, for now, so every time you read an entity attribute that is stored on S3, it will be downloaded from bucket provider.

Configuration

The S3Storage class constructor needs an S3 bucket name.

If you want to put your aws credentials in an other file than the default (~/.aws/credentials), you must set the AWS_CONFIG_FILE environment variable.

If you want to use another profile name than default, set the AWS_PROFILE environment variable.

If you prefer to configure AWS credentials by environment variables (eg. when using docker), you can use the following variables:

AWS_ACCESS_KEY_ID: the access key for your AWS account,
AWS_SECRET_ACCESS_KEY: the secret key for your AWS account.

Please read boto3 documentation for more details.

Further configuration

In some cases you might want to use compatible S3 storage which is not on AWS.

For this you have the following variables :

AWS_S3_ENDPOINT_URL: endpoint url for your alternative S3 storage

This enables the use of a minio server, see their documentation about endpoints.

Note : this type of variable has been requested upstream (and related aws-cli).

cubicweb-s3storage dependencies

boto3 cubicweb

FAQs

What is cubicweb-s3storage?

A Cubicweb Storage that stores the data on S3. Visit Snyk Advisor to see a full health score report for cubicweb-s3storage, including popularity, security, maintenance & community analysis.

Is cubicweb-s3storage popular?

The python package cubicweb-s3storage receives a total of 621 weekly downloads. As such, cubicweb-s3storage popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is cubicweb-s3storage well maintained?

We found indications that cubicweb-s3storage maintenance is sustainable demonstrating some project activity. We saw a total of 140 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is cubicweb-s3storage safe to use?

While scanning the latest version of cubicweb-s3storage, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 4 July-2024, at 16:29 (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

cubicweb-s3storage

A Cubicweb Storage that stores the data on S3 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

Summary

Configuration

Further configuration

cubicweb-s3storage dependencies

FAQs

What is cubicweb-s3storage?

Is cubicweb-s3storage popular?

Is cubicweb-s3storage well maintained?

Is cubicweb-s3storage 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

Summary

Configuration

Further configuration

cubicweb-s3storage dependencies

FAQs

What is cubicweb-s3storage?

Is cubicweb-s3storage popular?

Is cubicweb-s3storage well maintained?

Is cubicweb-s3storage 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