.. image:: https://raw.githubusercontent.com/torchbox/buckup/master/logo.png
:alt: Buckup logo
buckup
========
Create S3 bucket, policy and user with one command. After creation it is ready
to use on your project.
Features
--------
- Create bucket
- Enable `versioning <https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html>`_
- Set `CORS <https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html>`_
- Create user and generate access key pair and give it permissions to the
bucket.
- Set policy to enable
`s3:GetObject <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html>`_
permission on every object in your bucket to the public.
Dependencies
------------
* Python 3
* `boto3 <https://pypi.org/project/boto3/>`_
Installation
------------
PyPI (pip)
~~~~~~~~~~
.. code:: sh
python3 -m pip install buckup
Arch User Repository
~~~~~~~~~~~~~~~~~~~~
Buckup `can be found on AUR <https://aur.archlinux.org/packages/buckup>`_.
.. code:: sh
cd /tmp
git clone https://aur.archlinux.org/buckup.git
cd buckup
makepkg -si
Homebrew
~~~~~~~~
Buckup can be installed from Torchbox's `Homebrew tap <https://github.com/torchbox/homebrew-tap>`_.
.. code:: sh
brew tap torchbox/tap
brew install buckup
Development build
~~~~~~~~~~~~~~~~~
You can easily install buckup inside a virtual environment and work on it
there, e.g.
.. code:: sh
git clone git@github.com:torchbox/buckup.git
cd buckup
python3 -m venv venv
source venv/bin/activate
pip install -e .
buckup
Usage
-----
1. First you need an AWS account. You need programmatic access key to use it
with buckup.
* If you have `AWS CLI <https://aws.amazon.com/cli/>`_ installed,
you can save your credentials with
`aws configure <https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html>`_; or
* you can set ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY``
environment variable containing your credentials.
Read
`boto3 documentation <https://boto3.readthedocs.io/en/latest/guide/configuration.html>`_
for more detail.
1. If you want to restrict your access only to essential credentials to use
buckup, please set them to:
* ``iam:ListAccountAliases`` (not required to use)
* ``s3:PutBucketPolicy``
* ``s3:CreateBucket``
* ``iam:GetUser``
* ``iam:CreateUser``
* ``s3:PutBucketCORS``
* ``s3:PutBucketVersioning``
* ``iam:CreateAccessKey``
2. After you set that up, you can type ``buckup`` and that should open the
prompt.
1. If you want to specify other than the default region, please use ``--region``
flag with ``buckup``, e.g. ``buckup --region eu-west-2``.
3. After you answer all the questions you should obtain your bucket details
that are ready to use in your application.
.. image:: https://raw.githubusercontent.com/torchbox/buckup/master/screenshot.png
:alt: Screenshot of buckup’s command line output, showing the creation of a test bucket
Raw data
{
"_id": null,
"home_page": "https://github.com/torchbox/buckup",
"name": "buckup",
"maintainer": "Torchbox",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "info@torchbox.com",
"keywords": "aws,s3,bucket,storage,cloud",
"author": "Tomasz Knapik",
"author_email": "tomasz.knapik@torchbox.com",
"download_url": "https://files.pythonhosted.org/packages/99/12/c81eddaa26f13190693a7afafd9ce5bf6cc51065ab8d3a3c70833a243561/buckup-0.1a7.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/torchbox/buckup/master/logo.png\n :alt: Buckup logo\n\nbuckup\n========\n\nCreate S3 bucket, policy and user with one command. After creation it is ready\nto use on your project.\n\n\nFeatures\n--------\n\n- Create bucket\n- Enable `versioning <https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html>`_\n- Set `CORS <https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html>`_\n- Create user and generate access key pair and give it permissions to the\n bucket.\n- Set policy to enable\n `s3:GetObject <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html>`_\n permission on every object in your bucket to the public.\n\nDependencies\n------------\n\n* Python 3\n* `boto3 <https://pypi.org/project/boto3/>`_\n\nInstallation\n------------\n\nPyPI (pip)\n~~~~~~~~~~\n\n.. code:: sh\n\n python3 -m pip install buckup\n\nArch User Repository\n~~~~~~~~~~~~~~~~~~~~\n\nBuckup `can be found on AUR <https://aur.archlinux.org/packages/buckup>`_.\n\n.. code:: sh\n\n cd /tmp\n git clone https://aur.archlinux.org/buckup.git\n cd buckup\n makepkg -si\n\nHomebrew\n~~~~~~~~\n\nBuckup can be installed from Torchbox's `Homebrew tap <https://github.com/torchbox/homebrew-tap>`_.\n\n.. code:: sh\n\n brew tap torchbox/tap\n brew install buckup\n\nDevelopment build\n~~~~~~~~~~~~~~~~~\n\nYou can easily install buckup inside a virtual environment and work on it\nthere, e.g.\n\n.. code:: sh\n\n git clone git@github.com:torchbox/buckup.git\n cd buckup\n python3 -m venv venv\n source venv/bin/activate\n pip install -e .\n buckup\n\n\nUsage\n-----\n\n1. First you need an AWS account. You need programmatic access key to use it\n with buckup.\n\n * If you have `AWS CLI <https://aws.amazon.com/cli/>`_ installed,\n you can save your credentials with\n `aws configure <https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html>`_; or\n * you can set ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY``\n environment variable containing your credentials.\n\n Read\n `boto3 documentation <https://boto3.readthedocs.io/en/latest/guide/configuration.html>`_\n for more detail.\n\n 1. If you want to restrict your access only to essential credentials to use\n buckup, please set them to:\n\n * ``iam:ListAccountAliases`` (not required to use)\n * ``s3:PutBucketPolicy``\n * ``s3:CreateBucket``\n * ``iam:GetUser``\n * ``iam:CreateUser``\n * ``s3:PutBucketCORS``\n * ``s3:PutBucketVersioning``\n * ``iam:CreateAccessKey``\n\n2. After you set that up, you can type ``buckup`` and that should open the\n prompt.\n\n 1. If you want to specify other than the default region, please use ``--region``\n flag with ``buckup``, e.g. ``buckup --region eu-west-2``.\n\n3. After you answer all the questions you should obtain your bucket details\n that are ready to use in your application.\n\n.. image:: https://raw.githubusercontent.com/torchbox/buckup/master/screenshot.png\n :alt: Screenshot of buckup\u2019s command line output, showing the creation of a test bucket\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Create S3 buckets in seconds from your command line to use on your website.",
"version": "0.1a7",
"project_urls": {
"Homepage": "https://github.com/torchbox/buckup"
},
"split_keywords": [
"aws",
"s3",
"bucket",
"storage",
"cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3567e9c2211a24af26b03e88ba953f05271d576dc4b1eeb39cf2ea2ba37d9fcb",
"md5": "6f7200f1822cd3c7e61d66fd46470491",
"sha256": "7dc0449e193b53bc2b564ef98edb8468b7bec2818ae724e7ac76e53fb5b1405e"
},
"downloads": -1,
"filename": "buckup-0.1a7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f7200f1822cd3c7e61d66fd46470491",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 10262,
"upload_time": "2023-07-12T13:49:40",
"upload_time_iso_8601": "2023-07-12T13:49:40.581330Z",
"url": "https://files.pythonhosted.org/packages/35/67/e9c2211a24af26b03e88ba953f05271d576dc4b1eeb39cf2ea2ba37d9fcb/buckup-0.1a7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9912c81eddaa26f13190693a7afafd9ce5bf6cc51065ab8d3a3c70833a243561",
"md5": "98acfb2cc690a410d0f7f67814f19d46",
"sha256": "ca5f521e1856084a11941e5920231848274dd27d613dbf81b313a115d96afb4e"
},
"downloads": -1,
"filename": "buckup-0.1a7.tar.gz",
"has_sig": false,
"md5_digest": "98acfb2cc690a410d0f7f67814f19d46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 10333,
"upload_time": "2023-07-12T13:49:41",
"upload_time_iso_8601": "2023-07-12T13:49:41.943768Z",
"url": "https://files.pythonhosted.org/packages/99/12/c81eddaa26f13190693a7afafd9ce5bf6cc51065ab8d3a3c70833a243561/buckup-0.1a7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 13:49:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "torchbox",
"github_project": "buckup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "buckup"
}
JSON
