Migrate setup.py to pyproject.toml #11057

Author: jacobtylerwalls

.github/workflows/main.yml

@@ -42,9 +42,7 @@ jobs:
       - name: Install Python packages
         run: |
           python -m pip install --upgrade pip
-          pip install .
-          pip install -r ${{ github.event.repository.name }}/install/requirements.txt
-          pip install -r ${{ github.event.repository.name }}/install/requirements_dev.txt
+          pip install '.[dev]'
           echo Python packages installed
 
       - uses: ankane/setup-elasticsearch@v1
@@ -144,9 +142,7 @@ jobs:
       - name: Install Python packages
         run: |
           python -m pip install --upgrade pip
-          pip install .
-          pip install -r ${{ github.event.repository.name }}/install/requirements.txt
-          pip install -r ${{ github.event.repository.name }}/install/requirements_dev.txt
+          pip install '.[dev]'
           echo Python packages installed
 
       - uses: ankane/setup-elasticsearch@v1

.travis.yml

@@ -14,10 +14,6 @@ FROM base as wheelbuilder
 
 WORKDIR ${WHEELS}
 
-# Install pip requirements files
-COPY ./arches/install/requirements.txt ${WHEELS}/requirements.txt
-COPY ./arches/install/requirements_dev.txt ${WHEELS}/requirements_dev.txt
-
 # Install packages required to build the python libs, then remove them
 RUN set -ex \
     && BUILD_DEPS=" \
@@ -42,9 +38,7 @@ RUN set -ex \
     && curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py \
     && python3.8 get-pip.py
 
-RUN pip3 wheel --no-cache-dir -b /tmp -r ${WHEELS}/requirements.txt  \
-    && pip3 wheel --no-cache-dir -b /tmp -r ${WHEELS}/requirements_dev.txt  \
-    && pip3 wheel --no-cache-dir -b /tmp gunicorn \
+RUN pip3 wheel --no-cache-dir -b /tmp gunicorn \
     && pip3 wheel --no-cache-dir -b /tmp django-auth-ldap
 
 # Add Docker-related files
@@ -100,10 +94,6 @@ RUN python3.8 -m venv ENV \
     && pip install requests \
     && pip install -f ${WHEELS} django-auth-ldap \
     && pip install -f ${WHEELS} gunicorn \
-    && pip install -r ${WHEELS}/requirements.txt \
-                   -f ${WHEELS} \
-    && pip install -r ${WHEELS}/requirements_dev.txt \
-                   -f ${WHEELS} \
     && rm -rf ${WHEELS} \
     && rm -rf /root/.cache/pip/*
 
@@ -115,7 +105,7 @@ COPY . ${ARCHES_ROOT}
 WORKDIR ${ARCHES_ROOT}
 
 RUN . ../ENV/bin/activate \
-    && pip install -e . --no-binary :all:
+    && pip install -e '.[dev]' --no-binary :all:
 
 # Set default workdir
 WORKDIR ${ARCHES_ROOT}

Dockerfile

@@ -1,22 +1,26 @@
 recursive-include arches *
 include README.md
 exclude Dockerfile
+exclude manage.py
 exclude arches/logs/*.txt
 exclude arches/settings_local.py
 exclude .*
 exclude *.yml
 recursive-exclude .eggs *
 recursive-exclude .github *
 recursive-exclude .idea *
+recursive-exclude contributing *
+recursive-exclude cypress *
 recursive-exclude docker *
+recursive-exclude node_modules *
+recursive-exclude releases *
 recursive-exclude tests *
 recursive-exclude docs *
 recursive-exclude virtualenv *
-recursive-exclude arches/elasticsearch *
+recursive-exclude webpack *
 recursive-exclude arches/uploadedfiles *
-recursive-exclude arches/tileserver *
-recursive-exclude arches/app/media/packages *
-recursive-exclude arches/app/media/js/docs *
+recursive-exclude arches/staticfiles *
+recursive-exclude arches/app/media/build *
 global-exclude *.log
 global-exclude *.pyc
 global-exclude *.zip

MANIFEST.in

@@ -1,5 +1,5 @@
 from __future__ import absolute_import
-from arches.setup import get_version
+from arches.version import get_version
 
 try:
     # This will make sure the app is always imported when

arches/__init__.py

@@ -33,7 +33,7 @@
 from arches.app.models.system_settings import settings
 from arches.app.utils.betterJSONSerializer import JSONSerializer, JSONDeserializer
 from arches.app.utils.i18n import capitalize_region
-from arches.setup import unzip_file
+from arches.app.utils.zip import unzip_file
 from .formats.csvfile import CsvReader
 from .formats.archesfile import ArchesFileReader
 import ctypes

arches/app/utils/data_management/resources/importer.py

@@ -16,11 +16,10 @@
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 """
 
-import os
+import tarfile
 import zipfile
-import datetime
 from io import BytesIO
-from arches.app.models import models
+
 from django.http import HttpResponse
 
 
@@ -54,3 +53,15 @@ def zip_response(files_for_export, zip_file_name=None, filekey="outputfile"):
     response["Content-Type"] = "application/zip"
     response.write(zip_stream)
     return response
+
+
+def unzip_file(file_name, unzip_location):
+    try:
+        # first assume you have a .tar.gz file
+        tar = tarfile.open(file_name, "r:gz")
+        tar.extractall(path=unzip_location)
+        tar.close()
+    except:
+        # next assume you have a .zip file
+        with zipfile.ZipFile(file_name, "r") as myzip:
+            myzip.extractall(unzip_location)

arches/app/utils/zip.py

@@ -42,9 +42,7 @@ jobs:
       - name: Install Python packages
         run: |
           python -m pip install --upgrade pip
-          pip install .
-          pip install -r ${{ github.event.repository.name }}/install/requirements.txt
-          pip install -r ${{ github.event.repository.name }}/install/requirements_dev.txt
+          pip install '.[dev]'
           echo Python packages installed
 
       - uses: ankane/setup-elasticsearch@v1
@@ -144,9 +142,7 @@ jobs:
       - name: Install Python packages
         run: |
           python -m pip install --upgrade pip
-          pip install .
-          pip install -r ${{ github.event.repository.name }}/install/requirements.txt
-          pip install -r ${{ github.event.repository.name }}/install/requirements_dev.txt
+          pip install '.[dev]'
           echo Python packages installed
 
       - uses: ankane/setup-elasticsearch@v1

arches/install/arches-templates/.github/workflows/main.yml

@@ -20,13 +20,23 @@ classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
     "Intended Audience :: Information Technology",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
 ]
 requires-python = ">=3.10"
 dependencies = [
     "arches>={{ arches_semantic_version }},<{{ arches_next_minor_version }}",
 ]
 version = "0.0.1"
 
+[project.optional-dependencies]
+dev = [
+    "livereload",
+    "sst",
+    "coverage",
+    "django-silk==5.1.0",
+    "pre-commit",
+    "black==24.4.2",
+]
+
 [tool.setuptools]
 packages = ["{{ project_name }}"]

arches/install/arches-templates/project_name/install/requirements.txt

@@ -22,7 +22,7 @@ import os
 
 try:
     from django.utils.translation import gettext_lazy as _
-except ImportError:  # unable to import prior to installing requirements.txt in setup.py
+except ImportError:  # unable to import prior to installing requirements
     pass
 
 PACKAGE_NAME = "{{ project_name }}"

arches/install/arches-templates/project_name/install/requirements_dev.txt

@@ -7,12 +7,12 @@
 import sys
 import subprocess
 
-from importlib import import_module
 from django.core.management.templates import TemplateCommand
 from django.core.management.base import CommandError
 from django.utils.crypto import get_random_string
+
 from arches import __version__
-from arches.setup import get_complete_version
+from arches.version import get_complete_version
 
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "arches.settings")

arches/install/arches-templates/pyproject.toml

@@ -3,19 +3,15 @@
 import arches
 import argparse
 import codecs
-import django
-import errno
 import os
 import sys
 import subprocess
-import shutil
-from importlib import import_module
+
 from django.utils.crypto import get_random_string
-from django.core.management.utils import handle_extensions
 from django.core.management.templates import TemplateCommand
-from django.core.management.base import BaseCommand, CommandError
-from arches.setup import get_complete_version
-from arches.management.commands import utils
+from django.core.management.base import CommandError
+
+from arches.version import get_complete_version
 
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "arches.settings")

arches/install/arches-templates/tests/test_settings.py-tpl

@@ -19,7 +19,6 @@ source /home/ubuntu/ENV/bin/activate
 
 cd /home/ubuntu/arches
 pip install -e . --no-binary :all:
-pip install -r arches/install/requirements.txt
 
 # cd /home/ubuntu
 # arches-project create arches_dev