python-file-storage

v0.3.0

A Python package that exposes a consistent API for working with different storage backends. For more information about how to use this package see README

Latest version published 9 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

70 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Popularity

Small

GitHub Stars: 2.73K
Forks: 852
Contributors: 240

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package python-file-storage, we found that it has been starred 2,728 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jan 24, 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

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like python-file-storage 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

Open Issues: 96
Open PR: 26
Last Release: 9 months ago
Last Commit: 1 month ago

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

We found that python-file-storage 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: No
Code of Conduct: No
Contributors: 240
Funding: Yes

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

We found a way for you to contribute to the project! Looks like python-file-storage is missing a Code of Conduct.

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.8

Age: 1 year
Latest Release: 9 months ago
Dependencies: 0 Direct
Versions: 4
Maintainers: 1
Wheels: OS Independent

Readme

python-file-storage

A Python package that exposes a consistent API for working with different storage backends.

WARNING: This is still under active development.

Why does this package exist?

I needed something that does not depend on Django but exposes a similar interface to Django's base storage in django.core.files.storage.base.Storage. So, if you're using Django: use Django and django-storages instead. Currently, this package only does the bare minimum that I need it for so if you're looking for something more full-featured perhaps look at the cloudstorage package.

Available backends

Filesystem.
Amazon S3.

Quickstart

Install the package:
```
pip install python-file-storage
```
Add your configuration. Set the following as environment variables or add them to a .env file in the root of your project:
```
DEFAULT_STORAGE_BACKEND = storage.backends.s3.S3Storage
S3_BUCKET_NAME = my-bucket-name
S3_ENDPOINT_URL = example.com # Optional
S3_ACCESS_KEY_ID = 123
S3_SECRET_ACCESS_KEY = 123
```
Currently, using more than one storage backend at a time is unsupported.

Import default_storage and start using the package:

from storage import default_storage

default_storage.save('example.txt', 'Content')
file = default_storage.open('example.txt', 'Content')

Compatibility

Python 3.8+
Django is unsupported.

Versioning

This project follows semantic versioning (SemVer).

FAQs

What is python-file-storage?

A Python package that exposes a consistent API for working with different storage backends. Visit Snyk Advisor to see a full health score report for python-file-storage, including popularity, security, maintenance & community analysis.

Is python-file-storage popular?

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

Is python-file-storage well maintained?

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

Is python-file-storage safe to use?

The python package python-file-storage 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 7 October-2024, at 17:37 (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

Package Health Score

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

python-file-storage

Why does this package exist?

Available backends

Quickstart

Compatibility

Versioning

FAQs

What is python-file-storage?

Is python-file-storage popular?

Is python-file-storage well maintained?

Is python-file-storage 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