{"id":20331006,"url":"https://github.com/cans/pip-configure","last_synced_at":"2025-08-23T05:36:40.406Z","repository":{"id":139898294,"uuid":"88545641","full_name":"cans/pip-configure","owner":"cans","description":"Simple Ansible Role that Configures PIP","archived":false,"fork":false,"pushed_at":"2018-05-08T09:13:24.000Z","size":25,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-04T12:28:56.126Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cans.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-17T20:00:49.000Z","updated_at":"2018-05-08T09:12:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"cc0f63fa-d9c7-4485-943e-2e1783ab5b76","html_url":"https://github.com/cans/pip-configure","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/cans/pip-configure","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cans%2Fpip-configure","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cans%2Fpip-configure/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cans%2Fpip-configure/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cans%2Fpip-configure/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cans","download_url":"https://codeload.github.com/cans/pip-configure/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cans%2Fpip-configure/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271745603,"owners_count":24813511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T20:18:27.808Z","updated_at":"2025-08-23T05:36:40.374Z","avatar_url":"https://github.com/cans.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"cans.pip-configure\n==================\n\n[![Build Status](https://travis-ci.org/cans/pip-configure.svg?branch=master)](https://travis-ci.org/cans/pip-configure)\n[![Ansible Galaxy](https://img.shields.io/badge/ansible--galaxy-cans.pip--configure-blue.svg?style=flat-square)](https://galaxy.ansible.com/cans/pip-configure)\n[![License](https://img.shields.io/badge/license-GPLv2-brightgreen.svg?style=flat-square)](LICENSE)\n\nAnsible Role to setup pip to access private package indices and other\nPython package sources\n\n\nRequirements\n------------\n\nThis role has the requirements of Ansible's\n[template](http://docs.ansible.com/ansible/template_module.html) module.\n\n\nRole Variables\n--------------\n\nThis role variables are namespaced using the `pipconfig_` prefix.\n\n### Default variables\n\n- `pipconfig_dir`: the directory in which install pip's configuration\n  file. Make sure it is in a safe place, see comment on `pipconfig_dir`\n  item below. (default: `~/.pip/`);\n- `pipconfig_dir_mode`: the mode to set on the `pipconfig_dir`\n  directory. This it will contain a file that points you to different\n  network locations, you should make to not leave yourself open to\n  some misdirecting you by replacing its content with malicious one.\n  Only you and the root usr should be able to write in it or any of its\n  parents (defaults: 0500);\n- `pipconfig_file`: the name to give to pip configuration file\n  (default: `pip.conf`);\n- `pipconfig_file_mode`: the mode to set on the `pipconfig_file` file.\n  Be mindful that you may need to put credentials in it. Tightening the\n  permission is recommanded (default: 0400);\n- `pipconfig_timeout`: the duration in seconds pip will wait for any\n  package index to respond before droping the connexion and try with\n  the next (default: 10).\n\nYou most likely do not need to modify the value of the `pipconfig_file`\nvariables. Same goes for `pipconfig_dir`, but since pip supports many\nlocations for its configuration, these allow you to do it if you fancy\nit. One such case is if you want to have different pip configurations\nfor different Python [virtual environement](https://docs.python.org/3/library/venv.html).\n\nThe `pipconfig_timeout` variable you may want to adjust depending on\nwhere are stored the packages you need. The lower the value, the lesser\nyou wait, but the higher the risk of unexpected failures.\n\n\n### Input variables\n\nThese are the variables you need to set for the role to actually do\nsomething, useful:\n\n- `pipconfig_index_url`: the main PyPI index you want pip to look for\n  packages in (default: not defined);\n- `pipconfig_extra_index_urls`: the list of extra PyPI index you want\n  pip to look for packages from (default: `[]`).\n- `pipconfig_find_links_urls`: the list of extra web resources pip\n  should scan for links to Python packages (default: `[]`);\n\nIf you want to add one or more PyPI indexes for pip to search in\naddition to the default one, specify them as a list value for\n`pipconfig_extra_index_urls`.  If you want to override the default\nPyPI index entirely, specify your own main index as a string value for\n`pipconfig_index_url`.  You can use both variables if you want pip\nto ignore the default index *and* search multiple other PyPI indexes.\n\nThe `pipconfig_find_links_urls` can be used to find packages from\nlinks in web pages and\n[local directories](https://pip.pypa.io/en/stable/user_guide/#installing-from-local-packages)\n(in which case you might need to pass Ansible's\n[pip module](http://docs.ansible.com/ansible/latest/modules/pip_module.html)\nsome extra arguments).\n\n\nDependencies\n------------\n\nThis role has no dependencies.\n\n\nExample Playbook\n----------------\n\n    - hosts: servers\n      vars:\n        pipconfig_extra_index_urls:\n          - https://my-pypi.domain.com/simple\n        pipconfig_find_links_urls:\n          - https://my.domain.com/packages.html\n\n      roles:\n         - { role: \"cans.pip-config\" }\n\n\nLicense\n-------\n\nThe Ansible role pip-config is free software: you can redistribute it\nand/or modify it under the terms of the GNU General Public License\nversion 2 as published by the Free Software Foundation.\n\npip-config is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\nSee the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with cans.package-sources. If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\n\nAuthor Information\n------------------\n\nCopyright © 2017-2018, Nicolas CANIART\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcans%2Fpip-configure","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcans%2Fpip-configure","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcans%2Fpip-configure/lists"}