diff --git a/.github/workflows/release-keyring.yaml b/.github/workflows/release-keyring.yaml new file mode 100644 index 0000000..d156ef1 --- /dev/null +++ b/.github/workflows/release-keyring.yaml @@ -0,0 +1,35 @@ +name: Artifacts Helper Keyring Releases + +on: + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + + defaults: + run: + working-directory: src/artifacts-helper/codespaces_artifacts_helper_keyring + + steps: + - uses: actions/checkout@v4 + + - uses: wntrblm/nox@main + with: + python-versions: "3.11, 3.12" + + - name: Setup PDM + uses: pdm-project/setup-pdm@v4 + with: + version: "2.15.1" + python-version-file: "src/artifacts-helper/codespaces_artifacts_helper_keyring/pyproject.toml" + + - name: Run nox release + run: pdm release + + - name: Upload build artifacts + uses: actions/upload-artifact@v4 + with: + name: codespaces_artifacts_helper_keyring + path: | + src/artifacts-helper/codespaces_artifacts_helper_keyring/dist diff --git a/.github/workflows/test-keyring.yaml b/.github/workflows/test-keyring.yaml new file mode 100644 index 0000000..3f10c02 --- /dev/null +++ b/.github/workflows/test-keyring.yaml @@ -0,0 +1,59 @@ +name: Artifacts Helper Keyring Tests + +on: + push: + paths: + - ".github/workflows/test-keyring.yaml" + - "src/artifacts-helper/codespaces_artifacts_helper_keyring/**" + + pull_request: + branches: + - main + paths: + - ".github/workflows/test-keyring.yaml" + - "src/artifacts-helper/codespaces_artifacts_helper_keyring/**" + +defaults: + run: + working-directory: src/artifacts-helper/codespaces_artifacts_helper_keyring + +jobs: + generate-jobs: + name: Generate jobs + runs-on: ubuntu-latest + outputs: + session: ${{ steps.set-matrix.outputs.session }} + steps: + - uses: actions/checkout@v4 + + - uses: wntrblm/nox@main + with: + python-versions: "3.12" + + - id: set-matrix + shell: bash + run: echo session=$(nox --json -l --tags ci | jq -c '[.[].session]') | tee --append $GITHUB_OUTPUT + + checks: + name: Session ${{ matrix.session }} + needs: [generate-jobs] + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + session: ${{ fromJson(needs.generate-jobs.outputs.session) }} + steps: + - uses: actions/checkout@v4 + + - uses: wntrblm/nox@main + with: + python-versions: "3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10" + + - name: Setup PDM + uses: pdm-project/setup-pdm@v4 + with: + version: "2.15.1" + python-version-file: "src/artifacts-helper/codespaces_artifacts_helper_keyring/pyproject.toml" + + - name: Run ${{ matrix.session }} + run: pdm run nox --error-on-missing-interpreters --error-on-external-run -s "${{ matrix.session }}" diff --git a/src/artifacts-helper/codespaces_artifacts_helper_keyring/.gitignore b/src/artifacts-helper/codespaces_artifacts_helper_keyring/.gitignore new file mode 100644 index 0000000..62a0ffe --- /dev/null +++ b/src/artifacts-helper/codespaces_artifacts_helper_keyring/.gitignore @@ -0,0 +1,222 @@ +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +# PDM +.pdm-python + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### macOS Patch ### +# iCloud generated files +*.icloud + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ diff --git a/src/artifacts-helper/codespaces_artifacts_helper_keyring/README.md b/src/artifacts-helper/codespaces_artifacts_helper_keyring/README.md new file mode 100644 index 0000000..8f5cb8a --- /dev/null +++ b/src/artifacts-helper/codespaces_artifacts_helper_keyring/README.md @@ -0,0 +1,109 @@ +# codespaces_artifacts_helper_keyring + +The `codespaces_artifacts_helper_keyring` package provides [keyring](https://pypi.org/project/keyring) authentication for consuming Python packages from Azure Artifacts feeds using the [Codespaces Artifacts Helper](https://github.com/microsoft/codespace-features/tree/main/src/artifacts-helper) and its underlying authentication tool, [ado-codespaces-auth](https://github.com/microsoft/ado-codespaces-auth). + +This package is an extension to [keyring](https://pypi.org/project/keyring), which will automatically find and use it once installed. Both [pip](https://pypi.org/project/pip) and [twine](https://pypi.org/project/twine) will use keyring to find credentials. + +## Installation + +### From Source + +To install this package from source: + +```sh +$ cd src/artifacts-helper/codespaces_artifacts_helper_keyring + +# PDM is used to manage the project +$ pip install 'pdm>=2.14' + +# Install dependencies and build the package +$ pdm build + +# Install package and dependencies with pip +$ pip install dist/codespaces_artifacts_helper_keyring-*.whl +``` + +### From GitHub Releases + +TODO: Write instructions + +## Usage + +### Requirements + +To use `codespaces_artifacts_helper_keyring` to set up authentication between `pip` and Azure Artifacts, the following requirements must be met: + +- pip version **19.2** or higher +- python version **3.8** or higher +- running inside a Codespace with [Codespaces Artifacts Helper](https://github.com/microsoft/codespace-features/tree/main/src/artifacts-helper) and the `param` option set to `true`. This will automatically install the `codespaces_artifacts_helper_keyring` package for you. + ```json + { + "features": { + "ghcr.io/microsoft/codespace-features/artifacts-helper:1": { + // TODO: Add parameter for installing package + "TODO": true + } + } + } + ``` + +### Inner Workings + +The `codespaces_artifacts_helper_keyring` will detect if the package index has a domain that matches Azure Artifacts, e.g. `pkgs.dev.azure.com`. If it does, it will use the `ado-codespaces-auth` tool at `~/ado-auth-helper` to fetch an access token. This token will be used to authenticate with the Azure Artifacts feed. + +### Installing Packages from an Azure Artifacts Feed + +Once the codespace is ready, to consume a package, use the following `pip` command, replacing **** and **** with your own, and **** with the package you want to install: + +``` +pip install --index-url https://pkgs.dev.azure.com//_packaging//pypi/simple +``` + +## Contributing + +We use [PDM](https://pdm-project.org/) to manage the project and its dependencies. To get started, install PDM: + +```sh +$ pip install 'pdm>=2.14' +``` + +Then, install the project dependencies: + +```sh +$ pdm install +``` + +### Scripts + +A set of scripts are in `pyproject.toml` to help with common tasks. These can be run using `pdm