Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): move versioned_sidebars to static-assets #8743

Merged
merged 3 commits into from
Aug 30, 2023
Merged

feat(docs): move versioned_sidebars to static-assets #8743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80bb5dc
feat: make versioned_sidebar downloadable
yoonhyejin Aug 29, 2023
4685023
fix: revert api url branch
yoonhyejin Aug 29, 2023
987fa7c
Merge branch 'master' into docs/versioned_sidebar
yoonhyejin Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ metadata-ingestion/generated/**
# docs
docs/generated/
docs-website/versioned_docs/
docs-website/versioned_sidebars/
tmp*
temp/**

Expand Down
50 changes: 34 additions & 16 deletions docs-website/download_historical_versions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import json
import os
import tarfile
import urllib.request
import json

repo_url = "https://api.github.com/repos/datahub-project/static-assets"

Expand All @@ -16,30 +16,36 @@ def download_file(url, destination):
f.write(chunk)


def fetch_tar_urls(repo_url, folder_path):
def fetch_urls(repo_url: str, folder_path: str, file_format: str):
api_url = f"{repo_url}/contents/{folder_path}"
response = urllib.request.urlopen(api_url)
data = response.read().decode('utf-8')
tar_urls = [
file["download_url"] for file in json.loads(data) if file["name"].endswith(".tar.gz")
data = response.read().decode("utf-8")
urls = [
file["download_url"]
for file in json.loads(data)
if file["name"].endswith(file_format)
]
print(tar_urls)
return tar_urls
print(urls)
return urls


def main():
folder_path = "versioned_docs"
destination_dir = "versioned_docs"
def extract_tar_file(destination_path):
with tarfile.open(destination_path, "r:gz") as tar:
tar.extractall()
os.remove(destination_path)


def download_versioned_docs(folder_path: str, destination_dir: str, file_format: str):
if not os.path.exists(destination_dir):
os.makedirs(destination_dir)

tar_urls = fetch_tar_urls(repo_url, folder_path)
urls = fetch_urls(repo_url, folder_path, file_format)

for url in tar_urls:
for url in urls:
filename = os.path.basename(url)
destination_path = os.path.join(destination_dir, filename)

version = '.'.join(filename.split('.')[:3])
version = ".".join(filename.split(".")[:3])
extracted_path = os.path.join(destination_dir, version)
print("extracted_path", extracted_path)
if os.path.exists(extracted_path):
Expand All @@ -48,13 +54,25 @@ def main():
try:
download_file(url, destination_path)
print(f"Downloaded {filename} to {destination_dir}")
with tarfile.open(destination_path, "r:gz") as tar:
tar.extractall()
os.remove(destination_path)
if file_format == ".tar.gz":
extract_tar_file(destination_path)
except urllib.error.URLError as e:
print(f"Error while downloading {filename}: {e}")
continue


def main():
download_versioned_docs(
folder_path="versioned_docs",
destination_dir="versioned_docs",
file_format=".tar.gz",
)
download_versioned_docs(
folder_path="versioned_sidebars",
destination_dir="versioned_sidebars",
file_format=".json",
)


if __name__ == "__main__":
main()
Loading
Loading