-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #61 from PandABlocks/skeletonified-client
Skeletonified client
- Loading branch information
Showing
80 changed files
with
1,513 additions
and
1,315 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// For format details, see https://containers.dev/implementors/json_reference/ | ||
{ | ||
"name": "Python 3 Developer Container", | ||
"build": { | ||
"dockerfile": "../Dockerfile", | ||
"target": "build", | ||
// Only upgrade pip, we will install the project below | ||
"args": { | ||
"PIP_OPTIONS": "--upgrade pip" | ||
} | ||
}, | ||
"remoteEnv": { | ||
"DISPLAY": "${localEnv:DISPLAY}" | ||
}, | ||
// Add the URLs of features you want added when the container is built. | ||
"features": { | ||
"ghcr.io/devcontainers/features/common-utils:1": { | ||
"username": "none", | ||
"upgradePackages": false | ||
} | ||
}, | ||
// Set *default* container specific settings.json values on container create. | ||
"settings": { | ||
"python.defaultInterpreterPath": "/venv/bin/python" | ||
}, | ||
"customizations": { | ||
"vscode": { | ||
// Add the IDs of extensions you want installed when the container is created. | ||
"extensions": [ | ||
"ms-python.python", | ||
"tamasfe.even-better-toml", | ||
"redhat.vscode-yaml", | ||
"ryanluker.vscode-coverage-gutters" | ||
] | ||
} | ||
}, | ||
// Make sure the files we are mapping into the container exist on the host | ||
"initializeCommand": "bash -c 'for i in $HOME/.inputrc; do [ -f $i ] || touch $i; done'", | ||
"runArgs": [ | ||
"--net=host", | ||
"--security-opt=label=type:container_runtime_t" | ||
], | ||
"mounts": [ | ||
"source=${localEnv:HOME}/.ssh,target=/root/.ssh,type=bind", | ||
"source=${localEnv:HOME}/.inputrc,target=/root/.inputrc,type=bind", | ||
// map in home directory - not strictly necessary but useful | ||
"source=${localEnv:HOME},target=${localEnv:HOME},type=bind,consistency=cached" | ||
], | ||
// make the workspace folder the same inside and outside of the container | ||
"workspaceMount": "source=${localWorkspaceFolder},target=${localWorkspaceFolder},type=bind", | ||
"workspaceFolder": "${localWorkspaceFolder}", | ||
// After the container is created, install the python project in editable form | ||
"postCreateCommand": "pip install -e '.[dev]'" | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
name: Install requirements | ||
description: Run pip install with requirements and upload resulting requirements | ||
inputs: | ||
requirements_file: | ||
description: Name of requirements file to use and upload | ||
required: true | ||
install_options: | ||
description: Parameters to pass to pip install | ||
required: true | ||
python_version: | ||
description: Python version to install | ||
default: "3.x" | ||
|
||
runs: | ||
using: composite | ||
|
||
steps: | ||
- name: Setup python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: ${{ inputs.python_version }} | ||
|
||
- name: Pip install | ||
run: | | ||
touch ${{ inputs.requirements_file }} | ||
# -c uses requirements.txt as constraints, see 'Validate requirements file' | ||
pip install -c ${{ inputs.requirements_file }} ${{ inputs.install_options }} | ||
shell: bash | ||
|
||
- name: Create lockfile | ||
run: | | ||
mkdir -p lockfiles | ||
pip freeze --exclude-editable > lockfiles/${{ inputs.requirements_file }} | ||
# delete the self referencing line and make sure it isn't blank | ||
sed -i'' -e '/file:/d' lockfiles/${{ inputs.requirements_file }} | ||
shell: bash | ||
|
||
- name: Upload lockfiles | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: lockfiles | ||
path: lockfiles | ||
|
||
# This eliminates the class of problems where the requirements being given no | ||
# longer match what the packages themselves dictate. E.g. In the rare instance | ||
# where I install some-package which used to depend on vulnerable-dependency | ||
# but now uses good-dependency (despite being nominally the same version) | ||
# pip will install both if given a requirements file with -r | ||
- name: If requirements file exists, check it matches pip installed packages | ||
run: | | ||
if [ -s ${{ inputs.requirements_file }} ]; then | ||
if ! diff -u ${{ inputs.requirements_file }} lockfiles/${{ inputs.requirements_file }}; then | ||
echo "Error: ${{ inputs.requirements_file }} need the above changes to be exhaustive" | ||
exit 1 | ||
fi | ||
fi | ||
shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" | ||
|
||
- package-ecosystem: "pip" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
import json | ||
import logging | ||
from argparse import ArgumentParser | ||
from pathlib import Path | ||
from subprocess import CalledProcessError, check_output | ||
from typing import List, Optional | ||
|
||
|
||
def report_output(stdout: bytes, label: str) -> List[str]: | ||
ret = stdout.decode().strip().split("\n") | ||
print(f"{label}: {ret}") | ||
return ret | ||
|
||
|
||
def get_branch_contents(ref: str) -> List[str]: | ||
"""Get the list of directories in a branch.""" | ||
stdout = check_output(["git", "ls-tree", "-d", "--name-only", ref]) | ||
return report_output(stdout, "Branch contents") | ||
|
||
|
||
def get_sorted_tags_list() -> List[str]: | ||
"""Get a list of sorted tags in descending order from the repository.""" | ||
stdout = check_output(["git", "tag", "-l", "--sort=-v:refname"]) | ||
return report_output(stdout, "Tags list") | ||
|
||
|
||
def get_versions(ref: str, add: Optional[str], remove: Optional[str]) -> List[str]: | ||
"""Generate the file containing the list of all GitHub Pages builds.""" | ||
# Get the directories (i.e. builds) from the GitHub Pages branch | ||
try: | ||
builds = set(get_branch_contents(ref)) | ||
except CalledProcessError: | ||
builds = set() | ||
logging.warning(f"Cannot get {ref} contents") | ||
|
||
# Add and remove from the list of builds | ||
if add: | ||
builds.add(add) | ||
if remove: | ||
assert remove in builds, f"Build '{remove}' not in {sorted(builds)}" | ||
builds.remove(remove) | ||
|
||
# Get a sorted list of tags | ||
tags = get_sorted_tags_list() | ||
|
||
# Make the sorted versions list from main branches and tags | ||
versions: List[str] = [] | ||
for version in ["master", "main"] + tags: | ||
if version in builds: | ||
versions.append(version) | ||
builds.remove(version) | ||
|
||
# Add in anything that is left to the bottom | ||
versions += sorted(builds) | ||
print(f"Sorted versions: {versions}") | ||
return versions | ||
|
||
|
||
def write_json(path: Path, repository: str, versions: str): | ||
org, repo_name = repository.split("/") | ||
struct = [ | ||
{"version": version, "url": f"https://{org}.github.io/{repo_name}/{version}/"} | ||
for version in versions | ||
] | ||
text = json.dumps(struct, indent=2) | ||
print(f"JSON switcher:\n{text}") | ||
path.write_text(text, encoding="utf-8") | ||
|
||
|
||
def main(args=None): | ||
parser = ArgumentParser( | ||
description="Make a versions.txt file from gh-pages directories" | ||
) | ||
parser.add_argument( | ||
"--add", | ||
help="Add this directory to the list of existing directories", | ||
) | ||
parser.add_argument( | ||
"--remove", | ||
help="Remove this directory from the list of existing directories", | ||
) | ||
parser.add_argument( | ||
"repository", | ||
help="The GitHub org and repository name: ORG/REPO", | ||
) | ||
parser.add_argument( | ||
"output", | ||
type=Path, | ||
help="Path of write switcher.json to", | ||
) | ||
args = parser.parse_args(args) | ||
|
||
# Write the versions file | ||
versions = get_versions("origin/gh-pages", args.add, args.remove) | ||
write_json(args.output, args.repository, versions) | ||
|
||
|
||
if __name__ == "__main__": | ||
main() |
Oops, something went wrong.