Package init (#3)

* Package identification

* Code

* Add testing framework

* Add workflows for tests and release

* Reformat

* Fix bugs, refactor

* Refactor

* Django integration (#4)

* Add django integration

* Remove debug

* Add tests

* Bugfixes, refactor

* Fix tests

* Formatter and test setup

* Fix workflows

---------

Co-authored-by: Tomasz Kwiatkowski <[email protected]>

Author: MasloMaslane

.github/workflows/check_migrations.yml

@@ -0,0 +1,23 @@
+name: migrations
+run-name: Check if all migrations are created
+on:
+  push:
+    branches: 'main'
+  pull_request:
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    name: migrations-ubuntu
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      - name: Install dependencies
+        run: |
+          pip3 install .[django]
+      - name: Check migrations
+        run: |
+          python3 tests/test_django/manage.py makemigrations --dry-run --check

.github/workflows/formatter.yml

@@ -1,9 +1,9 @@
 name: Python Formatter (isort & black)
 
 on:
+  push:
+    branches: 'main'
   pull_request:
-    branches: [main]
-
 jobs:
   formatting:
     runs-on: ubuntu-latest
@@ -12,7 +12,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - name: Install isort and black
         run: |
           python -m pip install --upgrade pip

.github/workflows/macOS.yml

@@ -0,0 +1,47 @@
+name: pytest-macos
+run-name: Run pytest on macOS
+on:
+  push:
+    branches: 'main'
+  pull_request:
+
+jobs:
+  pytest:
+    runs-on: macos-latest
+    strategy:
+        matrix:
+            python-version: ["3.10", "3.13"]
+    name: pytest-macos-python-${{ matrix.python-version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up Homebrew
+        uses: Homebrew/actions/setup-homebrew@master
+      - name: Install Homebrew dependencies
+        run: |
+          rm -f /usr/local/bin/2to3* /usr/local/bin/python3* /usr/local/bin/idle3* \
+          /usr/local/bin/pydoc3* # Homebrew will fail if these exist
+          brew install virtualenv
+      - name: Install Python dependencies
+        run: |
+          python3 -m venv .venv
+          source .venv/bin/activate
+          pip install -e .[tests]
+      - name: Run pytest without Django
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: |
+          source .venv/bin/activate
+          pytest -v -n auto
+      - name: Run pytest with Django
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: |
+          source .venv/bin/activate
+          pip install -e .[tests,django_tests,django]
+          ./tests/test_django/manage.py migrate
+          pytest -v -n auto

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: publish
+run-name: Publish to PyPi
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-publish:
+    name: Build and publish to PyPi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: Install build
+        run: |
+          python3 -m pip install build
+          python3 -m pip install setuptools --upgrade
+      - name: Build
+        run: |
+          python3 -m build --sdist --wheel --outdir dist/ .
+      - name: Upload to release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload ${{ github.event.release.tag_name }} dist/*
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.TOKEN }}

.github/workflows/ubuntu.yml

@@ -0,0 +1,35 @@
+name: pytest-ubuntu
+run-name: Run pytest on Ubuntu
+on:
+  push:
+    branches: 'main'
+  pull_request:
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+        matrix:
+            python-version: ["3.10", "3.13"]
+    name: pytest-ubuntu-python-${{ matrix.python-version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip3 install -e .[tests]
+      - name: Run pytest without Django
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: |
+          python3 -m pytest -v -n auto
+      - name: Run pytest with Django
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: |
+          pip3 install -e .[tests,django_tests,django]
+          ./tests/test_django/manage.py migrate
+          python3 -m pytest -v -n auto

.gitignore

@@ -5,6 +5,7 @@ build
 .vscode
 .idea
 __pycache__
+tests/test_django/db.sqlite3
 
 # pytest-cov
 .coverage*

pyproject.toml

@@ -9,3 +9,4 @@ include_trailing_comma = true
 
 [tool.black]
 line_length = 120
+exclude = "migrations/"

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = test_django.settings
+pythonpath = ./tests/test_django
+markers =
+    no_django: marks tests that should be run without Django

setup.cfg

@@ -21,7 +21,8 @@ packages = find_namespace:
 packages_dir = src
 include_package_data = True
 python_requires = >=3.9
-install_requires = 
+install_requires =
+    PyYAML
 
 [options.packages.find]
 where = src
@@ -31,6 +32,10 @@ tests =
     pytest
     pytest-cov
     pytest-xdist
+django_tests =
+    pytest-django
+django =
+    django
 
 [tool:pytest]
 testpaths =

src/sio3pack/__init__.py

@@ -1 +1,33 @@
 __version__ = "0.0.1"
+
+from sio3pack.files import LocalFile
+from sio3pack.packages.exceptions import ImproperlyConfigured, PackageAlreadyExists
+from sio3pack.packages.package import Package
+
+
+def from_file(file: str | LocalFile, django_settings=None) -> Package:
+    """
+    Initialize a package object from a file (archive or directory).
+    :param file: The file path or File object.
+    :param django_settings: Django settings object.
+    :return: The package object.
+    """
+    if isinstance(file, str):
+        file = LocalFile(file)
+    return Package.from_file(file, django_settings=django_settings)
+
+
+def from_db(problem_id: int) -> Package:
+    """
+    Initialize a package object from the database.
+    If sio3pack isn't installed with Django support, it should raise an ImproperlyConfigured exception.
+    If there is no package with the given problem_id, it should raise an UnknownPackageType exception.
+    :param problem_id: The problem id.
+    :return: The package object.
+    """
+    try:
+        import django
+
+        return Package.from_db(problem_id)
+    except ImportError:
+        raise ImproperlyConfigured("sio3pack is not installed with Django support.")