CLI tool for creating a Python Package Repository in an S3 bucket.
S3PyPI is a CLI for creating a Python Package Repository in an S3 bucket.
An extended tutorial on this tool can be found here.
Install s3pypi using pip:
pip install s3pypi
Before you can start using
s3pypi, you must set up an S3 bucket for your Python Package Repository, with static website hosting enabled. Additionally, you need a CloudFront distribution for serving the packages in your S3 bucket to
pipover HTTPS. Both of these resources can be created using the CloudFormation templates provided in the
aws cloudformation create-stack --stack-name STACK_NAME \ --template-body file://cloudformation/s3-pypi.json \ --parameters ParameterKey=AcmCertificateArn,ParameterValue=ACM_CERT_ARN \ ParameterKey=DomainName,ParameterValue=DOMAIN_NAME
You can now use
s3pypito create Python packages and upload them to your S3 bucket. To hide packages from the public, you can use the
--privateoption to prevent the packages from being accessible directly via the S3 bucket (they will only be accessible via Cloudfront and you can use WAF rules to protect them). If switching between private and public is not flexible enough, you can use the
--acloption to directly specify the ACL. Alternatively, you can specify a secret subdirectory using the
cd /path/to/your-project/ s3pypi --bucket mybucket [--private | --acl ACL] [--secret SECRET]
Install your packages using
pipby pointing the
--extra-index-urlto your CloudFront distribution (optionally followed by a secret subdirectory):
pip install your-project --extra-index-url https://pypi.example.com/SECRET/
Alternatively, you can configure the index URL in
[global] extra-index-url = https://pypi.example.com/SECRET/
Currently there are no plans to add new features to s3pypi. If you have any ideas for new features, check out our contributing guidelines on how to get these on our roadmap.
Got any questions or ideas? We'd love to hear from you. Check out our contributing guidelines for ways to offer feedback and contribute.
Copyright (c) November Five BVBA. All rights reserved.
Licensed under the MIT License.