[{"_1":2,"_176":-5,"_177":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_155":156},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_108":109,"_146":-5,"_147":11,"_148":17,"_149":11,"_150":-5,"_151":11,"_152":-5,"_153":154},"canonicalUrl","https://hub.docker.com/r/kayako/pripy/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","kayako","reponame","pripy","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2017-11-24T07:48:09.653215Z","description","Maintain simple private pip repository on S3.","is_private","last_updated","2017-11-24T08:27:35.168619Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",848,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# PriPy\nMaintain simple private pip repository on S3.\n\n## Serving Packages\n\nPriPy can serve python packages from an S3 backed API gateway.\nTo set up the private repository you'll need to create a lambda function and make it accessible via API gateway.\n\nThe lambda function lists the packages and builds available on S3 and a build can be downloaded directly by the API gateway.\n\n### Setup\n\n#### Command line tool\nTo install the command line utility `pripy` simple install it with `pip`\n\n```sh\npip install --extra-index-url http://pripy.kayakodev.net/simple/ pripy\n```\n\nand you should have `pripy` installed on your machine\n\n```sh\npripy --help\n```\n\n#### Repository\nSetting up the repository consists of 3 steps\n\n- Setting up S3 bucket\n- Setting up Lambda function\n- Setting up API gateway\n- (Optional) Setting up a custom domain\n\nSetting up the S3 bucket is easy. Just create a new bucket using S3 console or aws cli\n\n```sh\naws --profile s3 mb pripy.bucket_name\n```\n\nNow create a new IAM role with following policies\n\n- AWSLambdaBasicExecutionRole\n- AWSLambdaS3ExecutionRole\n- Following custom policy to allow this role to list and get objects from S3 bucket\n\n

\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"s3:GetObject\",\n \"s3:GetObjectVersion\",\n \"s3:ListBucket\"\n ],\n \"Resource\": [\n pripy.py,\n pripy.py\n ]\n },\n {\n \"Effect\": \"Allow\",\n \"Action\": \"lambda:InvokeFunction\",\n \"Resource\": \"*\"\n }\n ]\n}\n```\n\n

\n\n\nAfter creating the role add following trust relationship configuration\n\n

\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": \"lambda.amazonaws.com\"\n },\n \"Action\": \"sts:AssumeRole\"\n },\n {\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": \"apigateway.amazonaws.com\"\n },\n \"Action\": \"sts:AssumeRole\"\n }\n ]\n}\n```\n\n

\n\nThis trust relationship lets Lambda and API gateway assume the role.\n\nSave the ARN of the role as it will be required during API Gateway configuration.\n\n#### Lambda function\n\nThe lambda function will be used to list all available packages and their builds. This function will also be responsible to authenticate the user request for us. The function ships with a very simple authentication provider which fetches the list of users and their password from S3 and tries to authenticate the request with it. However, authentication is completely optional and can be turned off if you want the repository to be publicly accessible.\n\n##### Setting up the function\n\nCreate a new Lambda function with the IAM role created in previous step. Feel free to choose any name, the example here will assume the name to be `PriPy`.\nZip `__init__.py`, `api.py` file and `auth.py` and upload it to Lambda, on MacOS X you can do\n\n```shell\nzip lambda.zip __init__.py api.py auth.py\n```\n\nto generate the zip file.\n\nConfigure the lambda handler function to `api.handle_lambda`.\n\nFinally, add following environment variables\n\n| Variable | Description |\n| -------------------- | ---------------------------------------- |\n| `BUCKET_NAME` | Name of the S3 bucket that was created in first step |\n| `AUTH_PROVIDER_NAME` | Valid values are `S3` or `NoAuth`, choose `NoAuth` if you don't require authentication |\n| `AUTH_BUCKET_NAME` | This option is valid only if `S3` authentication provider is chosen. The value of this variable is set to the S3 bucket where the credentials can be found. |\n| `AUTH_PROVIDER_FILE` | The file in `AUTH_BUCKET_NAME` which contains the credentials |\n\nYou may also want to make sure that the bucket which contains the credentials is properly secured and lambda function has permission to read the file.\n\n#### API Gateway\n\nAPI Gateway is responsible for authenticating the requests with authentication provider, invoking the Lambda function to list available packages and builds and finally serving builds from S3.\n\nThe Gateway provides three API endpoints in total.\n\n- GET `/simple/`\n- GET `/simple/{package}`\n- GET `/simple/{package}/{build}`\n\n| Endpoint | Description |\n| --------------------------- | --------------------------------------- |\n| `/simple/` | List all available packages |\n| `/simple/{package}/` | List all builds available for a package |\n| `/simple/{package}/{build}` | Download a build file |\n\nTo set up the API gateway, go to the API gateway console and create a new API set. The example here assumes the name to be `pripy`.\n\nInside the API, create three new resources\n\n- `/simple/`\n- `/simple/{package}/`\n- `/simple/{package}/{build}`\n\nPath parameter names are important to get right as the lambda function depends on the name of parameters.\n\n#### Configuration\n\nLet's setup the methods on these API resources now.\n\n##### simple resource\n\nCreate a GET method on `/simple` resource and configure it as follows\n\n| Option | Value |\n| ---------------------------- | ---------------------- |\n| Integration Type | Lambda |\n| Use Lambda Proxy Integration | Check |\n| Lambda Region | Lambda function region |\n| Lambda Function | `PriPy` |\n\nAfter saving the method, click on *Method Request* and add a header `Authorization`.\n\n##### packages resource\n\nCreate GET method on `/simple/{package}` and configure it as follows\n\n| Option | Value |\n| ---------------------------- | ---------------------- |\n| Integration Type | Lambda |\n| Use Lambda Proxy Integration | Check |\n| Lambda Region | Lambda function region |\n| Lambda Function | `PriPy` |\n\nAfter saving the method, click on *Method Request* and add a header `Authorization`.\n\n##### build resource\n\nCreate GET method on `/simple/{package}/{build}` and configure it as follows\n\n| Option | Value |\n| ---------------- | ---------------------------------------- |\n| Integration Type | AWS Service |\n| AWS Region | Region of the S3 bucket created in first step |\n| AWS Service | Simple Storage Service (s3) |\n| AWS Subdomain | Leave |\n| HTTP Method | `GET` |\n| Action Type | Use Path Override |\n| Path Override | `${stageVariables.bucket}/{package}/{build}` |\n| Execution Role | ARN of the IAM role created in second step |\n| Content Handling | Convert to binary (if needed) |\n\nWe are using a stage variable named `bucket` to route the requests to S3 bucket, this variable will be configured when the API is deployed.\n\nNow go to *Integration Request* and configure the *URL Path Parameters* as follows:\n\n| Name | Mapped From |\n| --------- | ----------------------------- |\n| `package` | `method.request.path.package` |\n| `build` | `method.request.path.build` |\n\nNow go back and go to *Method Response*, expand the row for HTTP Status `200` and add following *Response Headers for 200*\n\n- `Timestamp`\n- `Content-Type`\n- `Content-Length`\n\nGo back again and go to *Integration Response*, expand the row for method response status 200, set `Content handling` to `Convert to binary (if needed)` and add following header mappings:\n\n| Response Header | Mapping Value |\n| ---------------- | ---------------------------------------- |\n| `Timestamp` | `integration.response.header.Date` |\n| `Content-Type` | `integration.response.header.Content-Type` |\n| `Content-Length` | `integration.response.header.Content-Length` |\n\nWith API endpoints all configured, let's setup the binary support so that we can download the files from S3 via API gateway.\n\nSelect *Binary Support* from left most pane and add content types that you want to be able to download. `pripy` can push builds in all formats supported by `distutil` so it is sensible to mark all these formats as binary content.\n\n- `application/x-tar`\n- `application/x-binary`\n- `application/octet-stream`\n- `application/zip`\n- `binary/octet-stream`\n\n#### Authentication\n\nThe API gateway is now ready to use. The last step is to set up the authentication.\n\nSelect *pripy* API from left most pane and click on *Authorizers* under it. Configure the authorizer as follows:\n\n| Option | Value |\n| --------------------------- | ---------------------------------------- |\n| Lambda Region | Region of Lambda function |\n| Lambda Function | `pripy` |\n| Authorizer Name | Choose a name for authoriser |\n| Execution Role | ARN of the IAM role created in first step |\n| Identity token source | `method.request.header.Authorization` |\n| Token Validation Expression | Leave empty |\n| Result TTL in seconds | A sensible time to live in seconds for authentication results. Set this value to a reasonable number |\n\nNow enable authentication by following these steps:\n\n1. Go to `pripy` API\n2. Select GET /simple/ method\n3. Go to *Method Request*\n4. Edit *Authorization* and select the custom authorizer\n5. Save and repeat step 2 through 4 for remaining two methods\n\n### S3 Authentication\n\nIf you configured the API authentication to use S3 as a backend, make sure the file that is configured to provide credentials exists and contains valid JSON object.\n\nKeys in the JSON object are user names and their corresponding values are the passwords. Example:\n\n```json\n{\n \"user_one\": \"randompassword\",\n \"user_two\": \"anotherpassword\"\n}\n```\n\n### Deployment\n\nAPI Gateway and Lambda function is now ready for deployment.\n\nGo to API Gateway and select `pripy`. From `actions` menu select `Deploy API` and create a new stage. The example assumes the stage name to be `beta`.\n\nWhen the stage is created, select *Stage Variables* tab and add the stage variable:\n\n| Name | Value |\n| -------- | ---------------------------------------- |\n| `bucket` | s3 bucket name which contains the packages and builds |\n\n#### Custom domain\n\nYou can optionally configure a custom domain name with SSL to serve the repository.\n\nIn order to configure a custom domain name you must import the SSL certificate for the domain you want to use into AWS Certificate Manager. You can also request a fresh certificate if you don't have one already.\n\nSelect *Custom Domain Names* from left panel and select *Create Custom Domain Name*.\n\nConfigure the domain name as follows\n\n| Option | Value |\n| --------------- | ---------------------------------------- |\n| Domain Name | Domain name you want to use |\n| ACM Certificate | SSL Certificate for the domain |\n| Path | Leave |\n| Destination | Select Pripy API and select active stage |\n| | |\n\nCopy the *Distribution Domain Name* that was just generated and configure the DNS records for the domain to point to this distribution.\n\n## Managing packages\n\nPriPy also provides a handy command line utility `pripy`. \nThe command line can do various tasks to ease the management. For more details please see\n\n```sh\npripy --help\n```\n\nIt is thoroughly documented and up to date will current state of codebase.\n\n### Requirements\nA package which is to be maintained by PriPy must fulfil following requirements:\n\n- Setup configuration must be done in `setup.cfg` file. This is a good idea to follow in general because it\n makes the setup configuration consumable by external tools. PriPy reads the package information from `setup.cfg`\n file and fails if the file could not be found.\n- The package must follow basic semantic version scheme. It must declare the version in `setup.cfg` file\n as `major.minor.patch` string. Extended version information such as `beta` or `rc` are not supported right now.\n \n### Available Commands\n\nFollowing commands are available in `pripy` command line tool:\n\n| Command | Description |\n|---------|-------------|\n| build | Build source distribution |\n| bump | Bump version number |\n| publish | Publish a build to pripy |\n| sync | Synchronize external packages into pripy |\n| user | Add or remove pripy users |\n\n\n## Using With PIP\n\nInstalling packages with `pip` is fairly simple. The quickest way is to run\n\n```sh\npip install --extra-index-url https://username:password@pripy.repository.com/simple package_name\n```\n\nWhere the URL to API gateway must be substituted for example URL and `package_name` would be the package you want to install. Username and password can be omitted if authentication is not set up.\n\nNote that the path `/simple` in the URL is important otherwise `pip` will not be able to discover any package.\n\nTo permanently configure `pip` to use this repository you must edit `~/.pip/pip.conf` and include following:\n\n```ini\n[install]\nextra-index-url = https://username:password@pripy.repository.com/simple\n```\n\nNow `pip` will by default look into this repository every time you try to install a package with\n\n```sh\npip install package_name\n```\n\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",284009738,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_103":104,"_105":104,"_106":104,"_107":17},"id","23c75aa0902941e686389794b9a5904e","uuid","23c75aa0-9029-41e6-8638-9794b9a5904e","type","organization","orgname","full_name","Kayako","location","London, UK","company","Kayako Ltd.","profile_url","http://www.kayako.com/","date_joined","2015-01-30T10:01:23.806066Z","gravatar_url","","gravatar_email","badge","is_active","recentTags",[110],{"_111":40,"_112":113,"_114":115,"_86":116,"_117":118,"_46":135,"_136":113,"_137":29,"_138":52,"_53":139,"_140":141,"_142":126,"_143":135,"_144":62,"_145":17},"content_type","creator",206500,"full_size",283999203,18454272,"images",[119],{"_120":121,"_122":123,"_124":104,"_125":126,"_127":128,"_129":130,"_131":104,"_132":-5,"_133":115,"_59":62,"_134":-5},"architecture","amd64","digest","sha256:9889b1249c24ce0d302a107ceb2cb51b8c4ecc7307dc35496dc560ea1b60be9e","features","last_pulled","2026-09-23T15:30:43.57201582Z","last_pushed","2017-11-24T08:27:35Z","os","linux","os_features","os_version","size","variant","2017-11-24T08:27:34.813605Z","last_updater","last_updater_username","media_type","latest","repository",2096402,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":157,"_164":165,"_153":174,"_175":11},{"_36":158,"_38":159,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":160,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":161,"_75":17,"_76":163,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":162},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_166":60,"_167":-5,"_168":-5,"_169":170},"count","next","previous","results",[171],{"_111":40,"_112":113,"_114":115,"_86":116,"_117":172,"_46":135,"_136":113,"_137":29,"_138":52,"_53":139,"_140":141,"_142":126,"_143":135,"_144":62,"_145":17},[173],{"_120":121,"_122":123,"_124":104,"_125":126,"_127":128,"_129":130,"_131":104,"_132":-5,"_133":115,"_59":62,"_134":-5},[],"canDeleteTags","actionData","errors"]

kayako/pripy

Tags for kayako/pripy