Skip to content

Commit e4110fc

Browse files
committed
feat: Codespaces pip ADO auth via custom keyring backend
1 parent 06b81b7 commit e4110fc

11 files changed

Lines changed: 1785 additions & 0 deletions

File tree

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
### Python ###
2+
# Byte-compiled / optimized / DLL files
3+
__pycache__/
4+
*.py[cod]
5+
*$py.class
6+
7+
# C extensions
8+
*.so
9+
10+
# Distribution / packaging
11+
.Python
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
cover/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
.pybuilder/
77+
target/
78+
79+
# Jupyter Notebook
80+
.ipynb_checkpoints
81+
82+
# IPython
83+
profile_default/
84+
ipython_config.py
85+
86+
# pyenv
87+
# For a library or package, you might want to ignore these files since the code is
88+
# intended to run in multiple environments; otherwise, check them in:
89+
# .python-version
90+
91+
# pipenv
92+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
94+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
95+
# install all needed dependencies.
96+
#Pipfile.lock
97+
98+
# poetry
99+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100+
# This is especially recommended for binary packages to ensure reproducibility, and is more
101+
# commonly ignored for libraries.
102+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103+
#poetry.lock
104+
105+
# pdm
106+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
107+
#pdm.lock
108+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
109+
# in version control.
110+
# https://pdm.fming.dev/#use-with-ide
111+
.pdm.toml
112+
113+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
114+
__pypackages__/
115+
116+
# Celery stuff
117+
celerybeat-schedule
118+
celerybeat.pid
119+
120+
# SageMath parsed files
121+
*.sage.py
122+
123+
# Environments
124+
.env
125+
.venv
126+
env/
127+
venv/
128+
ENV/
129+
env.bak/
130+
venv.bak/
131+
132+
# Spyder project settings
133+
.spyderproject
134+
.spyproject
135+
136+
# Rope project settings
137+
.ropeproject
138+
139+
# mkdocs documentation
140+
/site
141+
142+
# mypy
143+
.mypy_cache/
144+
.dmypy.json
145+
dmypy.json
146+
147+
# Pyre type checker
148+
.pyre/
149+
150+
# pytype static type analyzer
151+
.pytype/
152+
153+
# Cython debug symbols
154+
cython_debug/
155+
156+
# PyCharm
157+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
158+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
159+
# and can be added to the global gitignore or merged into this file. For a more nuclear
160+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
161+
#.idea/
162+
163+
### Python Patch ###
164+
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
165+
poetry.toml
166+
167+
# ruff
168+
.ruff_cache/
169+
170+
# LSP config files
171+
pyrightconfig.json
172+
173+
# PDM
174+
.pdm-python
175+
176+
### macOS ###
177+
# General
178+
.DS_Store
179+
.AppleDouble
180+
.LSOverride
181+
182+
# Icon must end with two \r
183+
Icon
184+
185+
# Thumbnails
186+
._*
187+
188+
# Files that might appear in the root of a volume
189+
.DocumentRevisions-V100
190+
.fseventsd
191+
.Spotlight-V100
192+
.TemporaryItems
193+
.Trashes
194+
.VolumeIcon.icns
195+
.com.apple.timemachine.donotpresent
196+
197+
# Directories potentially created on remote AFP share
198+
.AppleDB
199+
.AppleDesktop
200+
Network Trash Folder
201+
Temporary Items
202+
.apdisk
203+
204+
### macOS Patch ###
205+
# iCloud generated files
206+
*.icloud
207+
208+
### Windows ###
209+
# Windows thumbnail cache files
210+
Thumbs.db
211+
Thumbs.db:encryptable
212+
ehthumbs.db
213+
ehthumbs_vista.db
214+
215+
# Dump file
216+
*.stackdump
217+
218+
# Folder config file
219+
[Dd]esktop.ini
220+
221+
# Recycle Bin used on file shares
222+
$RECYCLE.BIN/
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# codespaces artifacts helper keyring
2+
3+
wow what a long package name. i'm open to suggestions for renaming it.
4+
5+
## what is this?
6+
7+
The codespaces artifacts helper keyring is a package that provides a keyring implementation for the codespaces artifacts helper at https://github.com/microsoft/ado-codespaces-auth. When the keyring package and this keyring are both installed, pip will automatically use this keyring to store and retrieve credentials when accessing ADO package feeds.
8+
9+
## build instructins
10+
11+
This package uses `pyproject.toml`, and `pdm` for building. To build the package, run the following commands:
12+
13+
```sh
14+
cd src/artifacts-helper/codespaces_artifacts_helper_keyring
15+
16+
# PDM is used to manage the project
17+
$ pip install 'pdm>=2.14'
18+
19+
# Install dependencies and build the package
20+
$ pdm build
21+
22+
# Install package + deps with pip
23+
$ pip install dist/codespaces_artifacts_helper_keyring-*.whl
24+
```
25+
26+
## contributing
27+
28+
```sh
29+
# Lint
30+
$ pdm run check
31+
32+
# Format
33+
$ pdm run fmt
34+
35+
# Type check
36+
$ pdm nox -s mypy
37+
38+
# Test on current python version
39+
$ pdm run test
40+
41+
# Test on all supported python versions
42+
$ pdm run nox
43+
```
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import os
2+
3+
import nox
4+
5+
os.environ.update({"PDM_IGNORE_SAVED_PYTHON": "1"})
6+
7+
PYTHON_VERSIONS = ["3.8", "3.9", "3.10", "3.11", "3.12"]
8+
LOCATIONS = "src", "tests", "noxfile.py"
9+
10+
11+
@nox.session(py=PYTHON_VERSIONS)
12+
@nox.parametrize("keyring", ["20", "25.1"])
13+
@nox.parametrize("pyjwt", ["2.0.0", "2.8"])
14+
def tests(session, keyring, pyjwt):
15+
session.run_always("pdm", "install", "-G", "test", external=True)
16+
session.install(f"keyring=={keyring}")
17+
session.install(f"pyjwt=={pyjwt}")
18+
session.run("pdm", "test", *session.posargs, external=True)
19+
20+
21+
@nox.session
22+
def lint(session):
23+
session.run_always("pdm", "install", "-G", "lint", external=True)
24+
session.run("pdm", "check", external=True)
25+
26+
27+
@nox.session(py=PYTHON_VERSIONS)
28+
def mypy(session):
29+
session.run_always("pdm", "install", external=True)
30+
args = session.posargs or LOCATIONS
31+
session.run("pdm", "run", "mypy", *args, external=True)

0 commit comments

Comments
 (0)