PHPackages                             proximify/s3 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. proximify/s3

ActiveLibrary[File & Storage](/categories/file-storage)

proximify/s3
============

Access to AWS's Bucket interface without any hassle.

v1.0.2(5y ago)07MITPHPPHP >=7.1.0CI failing

Since Nov 13Pushed 5y ago2 watchersCompare

[ Source](https://github.com/Proximify/S3)[ Packagist](https://packagist.org/packages/proximify/s3)[ RSS](/packages/proximify-s3/feed)WikiDiscussions master Synced 5d ago

READMEChangelogDependencies (2)Versions (4)Used By (0)

Amazon S3
=========

[](#amazon-s3)

Amazon Simple Storage Service, or S3 in short, is a service to store and retrieve any amount of data, at any time, from anywhere on the web.

Table of contents
-----------------

[](#table-of-contents)

- See [table of contents](docs/toc.md).

Installation
------------

[](#installation)

```
composer require proximify/s3
```

API
---

[](#api)

Check out the [API documentation](docs/api.md).

Example
-------

[](#example)

### Create a bucket

[](#create-a-bucket)

```
$bucketName = 'yourUniqueBucketName';
$credetials = [
    'key' => 'API_KEY',
    'secret' => 'API_SECRET'
];

S3::init($credentials);
$result = S3::create($bucketName);
```

Options
-------

[](#options)

The table below shows all the available options accepted by `init` function.

ProgramDescription`region`Bucket region. See all the available regions [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)---

Testing
-------

[](#testing)

Go to dev directory and type:

```
../vendor/bin/phpunit tests/
```

**Note:** You will need AWS credentials to run the test suit. To get yours, follow the steps [here.](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html)

Contributing
------------

[](#contributing)

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to and actually do, grant us the rights to use your contribution. For details, visit our [Contributor License Agreement](https://github.com/Proximify/community/blob/master/docs/proximify-contribution-license-agreement.pdf).

When you submit a pull request, we will determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided. You will only need to do this once across all repositories using our CLA.

This project has adopted the [Proximify Open Source Code of Conduct](https://github.com/Proximify/community/blob/master/docs/code_of_conduct.md). For more information see the Code of Conduct FAQ or contact  with any additional questions or comments.

License
-------

[](#license)

Copyright (c) Proximify Inc. All rights reserved.

Licensed under the [GNU General Public License Version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) license.

**Software component** is made by [Proximify](https://proximify.com). We invite the community to participate.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~3 days

Total

3

Last Release

2004d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1322822?v=4)[Proximify](/maintainers/proximify)[@Proximify](https://github.com/Proximify)

---

Top Contributors

[![mertmetin](https://avatars.githubusercontent.com/u/1769973?v=4)](https://github.com/mertmetin "mertmetin (12 commits)")

---

Tags

amazon-s3

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/proximify-s3/health.svg)

```
[![Health](https://phpackages.com/badges/proximify-s3/health.svg)](https://phpackages.com/packages/proximify-s3)
```

###  Alternatives

[league/flysystem-aws-s3-v3

AWS S3 filesystem adapter for Flysystem.

1.6k263.6M790](/packages/league-flysystem-aws-s3-v3)[aws/aws-sdk-php-laravel

A simple Laravel 9/10/11/12/13 service provider for including the AWS SDK for PHP.

1.7k35.6M75](/packages/aws-aws-sdk-php-laravel)[humanmade/s3-uploads

WordPress plugin to store uploads on S3

2.1k2.4M9](/packages/humanmade-s3-uploads)[aws/aws-sdk-php-resources

A resource-oriented API for interacting with AWS services

1381.8M10](/packages/aws-aws-sdk-php-resources)[aws/aws-sdk-php-zf2

Zend Framework 2 Module that allows easy integration the AWS SDK for PHP

104997.5k5](/packages/aws-aws-sdk-php-zf2)[frostealth/yii2-aws-s3

An Amazon S3 component for Yii2

90698.9k5](/packages/frostealth-yii2-aws-s3)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)