Skip to content

Commit

Permalink
v1.1.2: Add blog posts to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iamirmasoud committed Apr 8, 2022
1 parent 0467958 commit c0377af
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Change Log:
**v1.1.1:**
- Add Standalone MinIO deployment link to README.md.
- Add blog posts to README.md.

**v1.1.1:**
- Fix licence badge.

Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#blog-posts">Blog Posts</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#contributors">Contributors</a></li>
<li><a href="#contact">Contact</a></li>
Expand Down Expand Up @@ -72,8 +73,13 @@ directories when transferring them. There are also some other features as follow

## Getting Started
### Prerequisites
* [Python 3.3+](https://www.python.org/)
* [Python 3.6+](https://www.python.org/)
* [pip](https://pip.pypa.io/en/stable/)
* API credentials to access an S3.

**Note**:
You can deploy a free S3 server using [MinIO](https://min.io/)
on your local machine by following steps explained in: [Deploy Standalone MinIO using Docker Compose on Linux](http://www.sefidian.com/2022/04/08/deploy-standalone-minio-using-docker-compose/).

### Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `bulkboto3`.
Expand Down Expand Up @@ -246,6 +252,10 @@ print(
Uploaded 88800 small files (totally about 7GB) with 100 threads in 505 seconds that is about
72X faster than the non-parallel mode.

## Blog Posts
- [BulkBoto3: Python package for fast and parallel transferring a bulk of files to S3 based on boto3!](http://www.sefidian.com/2022/03/28/bulkboto3-python-package-for-fast-and-parallel-transferring-a-bulk-of-files-to-s3-based-on-boto3/)
- [Deploy Standalone MinIO using Docker Compose on Linux](http://www.sefidian.com/2022/04/08/deploy-standalone-minio-using-docker-compose/).


## Contributing
Any contributions you make are **greatly appreciated**. If you have a suggestion that would make this better, please fork the repo and create a pull request.
Expand Down
2 changes: 1 addition & 1 deletion bulkboto3/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
from .transfer_path import StorageTransferPath

__author__ = "Amir Masoud Sefidian"
__version__ = "1.1.1"
__version__ = "1.1.2"

0 comments on commit c0377af

Please sign in to comment.