Replace setup.py with pyproject.toml #2476
Conversation
pyproject.toml
Outdated
| [tool.black] | ||
| line-length = 100 | ||
| target-version = ["py36", "py37"] | ||
| target-version = ["py39", "py310", "py311", "py312"] |
There was a problem hiding this comment.
we currently require minimum py311 so we can set to py311
|
Add the ui/build.py to galaxy_ng/sonar-project.properties Line 5 in 91c47c4 |
| import os | ||
| import tempfile | ||
| import tarfile | ||
| import shutil | ||
| import urllib.request | ||
| import urllib.error | ||
| from distutils import log | ||
|
|
||
| from setuptools.command.build_py import build_py as _BuildPyCommand | ||
| from setuptools.command.sdist import sdist as _SDistCommand | ||
|
|
||
| version = "4.11.0dev" | ||
|
|
||
| DEV_UI_DOWNLOAD_URL = ( | ||
| "https://github.com/ansible/ansible-hub-ui/" | ||
| "releases/download/dev/automation-hub-ui-dist.tar.gz" | ||
| ) | ||
|
|
||
| ALTERNATE_UI_DOWNLOAD_URL = os.environ.get("ALTERNATE_UI_DOWNLOAD_URL") | ||
|
|
||
| UI_DOWNLOAD_URL = ( | ||
| "https://github.com/ansible/ansible-hub-ui/" | ||
| f"releases/download/{version}/automation-hub-ui-dist.tar.gz" | ||
| ) | ||
| TARGET_DIR = "galaxy_ng/app/static/galaxy_ng" | ||
|
|
||
| FORCE_DOWNLOAD_UI = os.environ.get("FORCE_DOWNLOAD_UI", False) | ||
|
|
||
|
|
||
| def prepare_static(): | ||
| if os.path.exists(TARGET_DIR): | ||
| if FORCE_DOWNLOAD_UI: | ||
| log.warn(f"Removing {TARGET_DIR} and re downloading the UI.") | ||
| shutil.rmtree(TARGET_DIR) | ||
| else: | ||
| log.warn(f"Static directory {TARGET_DIR} already exists, skipping. ") | ||
| return | ||
|
|
||
| with tempfile.NamedTemporaryFile() as download_file: | ||
| log.info(f"Downloading UI distribution to temporary file: {download_file.name}") | ||
|
|
||
| if ALTERNATE_UI_DOWNLOAD_URL: | ||
| log.info(f"Downloading UI from {ALTERNATE_UI_DOWNLOAD_URL}") | ||
| _download_tarball(ALTERNATE_UI_DOWNLOAD_URL, download_file) | ||
| else: | ||
| log.info(f"Attempting to download UI for version {version}") | ||
| try: | ||
| _download_tarball(UI_DOWNLOAD_URL, download_file) | ||
| except urllib.error.HTTPError: | ||
| log.warn(f"Failed to retrieve UI for {version}. Downloading latest UI.") | ||
| _download_tarball(DEV_UI_DOWNLOAD_URL, download_file) | ||
|
|
||
| log.info(f"Extracting UI static files to {TARGET_DIR}") | ||
| with tarfile.open(fileobj=download_file) as tfp: | ||
| tfp.extractall(TARGET_DIR) | ||
|
|
||
|
|
||
| def _download_tarball(url, download_file): | ||
| urllib.request.urlretrieve(url, filename=download_file.name) | ||
|
|
||
|
|
||
| class SDistCommand(_SDistCommand): | ||
| def run(self): | ||
| prepare_static() | ||
| return super().run() | ||
|
|
||
|
|
||
| class BuildPyCommand(_BuildPyCommand): | ||
| def run(self): | ||
| prepare_static() | ||
| return super().run() |
There was a problem hiding this comment.
I wonder if these custom build entrypoints for preparing UI are still required?
We are not releasing to PyPI anymore, we dont inspect people to rely on the UI coming from the package.
AFAIK galaxy.ansible.com has UI deployed directly from UI repo, can you confirm @drodowic
Maybe we can just get rid of those custom entrypoints
There was a problem hiding this comment.
I think we should have a separate PR for that then,
so we can have it highlighted on the changelog that the UI was removed
There was a problem hiding this comment.
you are correct that galaxy.ansible.com deploys the UI seperately, and this built in UI in not utilized in the galaxy pipeline.
pyproject.toml
Outdated
| dependencies = [ | ||
| "boto3", | ||
| "distro", | ||
| "django-ansible-base[jwt-consumer,feature-flags] @ git+https://github.com/ansible/[email protected]", | ||
| "django-auth-ldap==4.0.0", | ||
| "django-crum==0.7.9", | ||
| "django-flags>=5.0.13", | ||
| "django-ipware<4.0.0,>=3.0.0", | ||
| "django-picklefield<4.0.0,>=3.0.1", | ||
| "django-prometheus>=2.0.0", | ||
| "drf-spectacular", | ||
| "dynaconf>=3.2.10", | ||
| "galaxy-importer>=0.4.27,<0.5.0", | ||
| "insights_analytics_collector>=0.3.0", | ||
| "marshmallow<4.0.0,>=3.6.1", | ||
| "pulp-container>=2.19.2,<2.20.0", | ||
| "pulp_ansible==0.23.1", | ||
| "pulpcore>=3.49.0,<3.50.0", | ||
| "social-auth-app-django>=5.2.0", | ||
| "social-auth-core>=4.4.2", | ||
| ] |
There was a problem hiding this comment.
we could do it dynamically as: https://github.com/ansible/aap-gateway/blob/devel/pyproject.toml#L27-L31
| return spec | ||
|
|
||
|
|
||
| unpin_requirements = os.getenv("LOCK_REQUIREMENTS") == "0" |
There was a problem hiding this comment.
It looks like we rely on LOCK_REQUIREMENTS on a lot of places and I am not sure how it would be with pyproject as it is a static file.
https://github.com/search?q=repo%3Aansible%2Fgalaxy_ng%20%20LOCK_REQUIREMENTS&type=code
There was a problem hiding this comment.
not sure, I need to research more
There was a problem hiding this comment.
actually, I realize both DJANGO_ANSIBLE_BASE_BRANCH and LOCK_REQUIREMENTS aren't pyproject.toml issues, we can handle those at dev environment level
| return super().run() | ||
|
|
||
|
|
||
| django_ansible_base_branch = os.getenv('DJANGO_ANSIBLE_BASE_BRANCH', '2025.3.7') |
There was a problem hiding this comment.
AFAIK DJANGO_ANSIBLE_BASE_BRANCH may be set by some testing pipelines, for example to point to devel how would we do it with pyproject?
There was a problem hiding this comment.
not sure, I need to research more
There was a problem hiding this comment.
fao89
force-pushed
the
pyproject
branch
3 times, most recently
from
053644b to
6e29f91
Compare
|
basically this works, but there is a little issue with |
Signed-off-by: Fabricio Aguiar <[email protected]> rh-pre-commit.version: 2.3.2 rh-pre-commit.check-secrets: ENABLED
|
No description provided.