djaxei 0.0.0__tar.gz

djaxei-0.0.0/.bumpversion.cfg

@@ -0,0 +1,13 @@
+[bumpversion]
+current_version = 1.2.1
+commit = True
+tag = False
+tag_name = "{new_version}"
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:src/djaxei/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

djaxei-0.0.0/.env.example

@@ -0,0 +1 @@
+PYPI_TOKEN=...

djaxei-0.0.0/.envrc.example

@@ -0,0 +1,21 @@
+dotenv
+
+layout_poetry() {
+    if [[ ! -f pyproject.toml ]]; then
+        log_error 'No pyproject.toml found. Use `poetry new` or `poetry init` to create one first.'
+        exit 2
+    fi
+
+    # local VENV=$(poetry env list --full-path | cut -d' ' -f1)
+    local VENV='.venv'
+    if [[ -z $VENV || ! -d $VENV/bin ]]; then
+        log_error 'No created poetry virtual environment found. Use `poetry install` to create one first.'
+        exit 2
+    fi
+    VENV=$VENV/bin
+    export VIRTUAL_ENV=$(echo "$VENV" | rev | cut -d'/' -f2- | rev)
+    export POETRY_ACTIVE=1
+    PATH_add "$VENV"
+}
+
+layout poetry

djaxei-0.0.0/.flake8

@@ -0,0 +1,8 @@
+[flake8]
+max-complexity = 12
+max-line-length = 120
+exclude = migrations settings
+ignore = E401,W391,E128,E261,E731,Q000,W504,W606
+
+per-file-ignores =
+    */__init__.py:F401,F403

djaxei-0.0.0/.gitignore

@@ -0,0 +1,19 @@
+.*
+~*
+!.gitignore
+!.env.example
+!.envrc.example
+!.bumpversion.cfg
+!.flake8
+!.isort.cfg
+!.pre-commit-config.yaml
+!tests/.coveragerc
+!.python-version
+
+__pycache__
+dist
+
+poetry.lock
+db.sqlite3
+*.egg-info
+*.pyc

djaxei-0.0.0/.isort.cfg

@@ -0,0 +1,13 @@
+[settings]
+combine_as_imports = true
+default_section = THIRDPARTY
+include_trailing_comma = true
+;forced_separate = django.contrib,django.utils
+line_length = 80
+known_future_library = future,pies
+;known_standard_library =
+known_third_party = rest_framework,django,constance,rest_framework
+known_first_party = bitcaster
+multi_line_output = 0
+balanced_wrapping = true
+sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER

djaxei-0.0.0/.pre-commit-config.yaml

@@ -0,0 +1,78 @@
+exclude: '^$'
+fail_fast: false
+repos:
+  - repo: local
+    hooks:
+      - id: ci-cache-key
+        name: update ci-cache-key
+        entry: sh .hooks/pre-commit.sh
+        language: system
+        stages: [commit]
+        files: Poetry.lock
+
+      - id: isort
+        args:
+          - --check-only
+        exclude: tweepy
+        name: isort
+        entry: isort
+        language: system
+        types: [python]
+        stages: [commit]
+
+      - id: flake8
+        exclude: /(_plugin_template|python_twitter|migrations|tweepy)/
+        name: flake8
+        entry: flake8
+        language: system
+        types: [python]
+        stages: [commit]
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: 0.9.1
+    hooks:
+    -   id: detect-secrets
+        args: ['--baseline', '.secrets.baseline']
+        exclude: (tests/.*|.*/tenant\.sql|Pipfile\.lock|.*\.js|.gitlab-ci.yml|poetry.lock)
+        stages: [push]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.1.0
+    hooks:
+      - id: double-quote-string-fixer
+        stages: [commit]
+
+      - id: debug-statements
+        exclude: (_plugin_template|python_twitter)
+        stages: [commit]
+
+      - id: end-of-file-fixer
+        exclude: .bumpversion.cfg
+        stages: [commit]
+
+      - id: check-merge-conflict
+        stages: [commit]
+
+      - id: check-case-conflict
+        stages: [commit]
+
+  - repo: https://github.com/saxix/pch
+    rev: fc387f4
+    hooks:
+      - id: check-version-release-match
+        args:
+          - --pythonpath=src
+          - --package=djaxei
+        stages: [push]
+
+      - id: check-untracked
+        args:
+          - src
+          - tests
+        stages: [push]
+
+      - id: check-forbidden
+        args:
+          - -p
+          - \.showbrowser\(
+        stages: [commit]

djaxei-0.0.0/.python-version

@@ -0,0 +1,5 @@
+3.9
+3.8
+3.10
+3.11
+3.12

djaxei-0.0.0/CHANGES.md

@@ -0,0 +1,4 @@
+Release 1.2.0
+=============
+* First changelog release
+* Fixing issue with package version showing as 0.0.0

djaxei-0.0.0/HISTORY.md

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2020-02-18)
+------------------
+
+* First release

djaxei-0.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020, Giovanni Bronzini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

djaxei-0.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE.txt
+include HISTORY.md
+include Makefile
+include pyproject.toml

djaxei-0.0.0/Makefile

@@ -0,0 +1,97 @@
+.PHONY: clean clean-test clean-pyc clean-build docs help
+.DEFAULT_GOAL := help
+
+VCS_CERT?=/usr/local/share/ca-certificates/path/my_company.crt
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr pip-wheel-metadata/
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+lint: ## check style with flake8
+	flake8 wlsclick tests
+
+test: ## run tests quickly with the default Python
+	pytest
+
+test-all: ## run tests on every Python version with tox
+	tox
+
+coverage: ## check code coverage quickly with the default Python
+	coverage run --source wlsclick -m pytest
+	coverage report -m
+	coverage html
+	$(BROWSER) htmlcov/index.html
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/wlsclick.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ wlsclick
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(BROWSER) docs/_build/html/index.html
+
+servedocs: docs ## compile the docs watching for changes
+	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+
+release: dist ## package and upload a release
+	poetry config pypi-token.pypi ${PYPI_TOKEN}
+	poetry publish
+
+dist: clean ## builds source and wheel package
+	poetry build -f sdist
+
+install: clean ## install the package to the active Python's site-packages
+	poetry install
+
+bump:   ## Bumps version
+	@while :; do \
+		read -r -p "bumpversion [major/minor/patch]: " PART; \
+		case "$$PART" in \
+			major|minor|patch) break ;; \
+  		esac \
+	done ; \
+	bumpversion --no-commit --allow-dirty $$PART
+	@grep "^version = " pyproject.toml

djaxei-0.0.0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: djaxei
+Version: 0.0.0
+License-File: LICENSE.txt
+Dynamic: license-file

djaxei-0.0.0/README.md

@@ -0,0 +1,45 @@
+# A django admin extension for importing exporting records from/to xls/ods
+
+A Python library project using:
+* pytest
+* flake8
+* tox
+* bumpversion
+* isort
+
+* Free software: MIT license
+* Documentation: __TBD__
+
+
+# Features
+
+- Requires Python >=3.8, Django>=3.2
+- Currently work only with xlsxwriter
+
+- Could help if use [direnv](https://direnv.net/) in dev environment
+
+# Contributing
+
+See [demo](tests%2Fdemo) in tests folder
+
+* TODO
+
+# Dev setup
+
+1. install direnv
+2. install pyenv
+3. clone project: `git clone https://github.com/GigiusB/djaxei.git`
+4. `cd djaxei`
+5. ```pyenv install `cat .python-version` ```
+6. `pip install -U poetry` # this should install poetry in your pyenv python
+7. `cp .env.example .env`
+8. `cp .envrc.example .envrc`
+9. `direnv allow`
+10. ```poetry env use `pyenv which python` ```
+11. `cd .. ; cd -`  # see if it loads the env
+12. poetry install
+13. pytest
+
+Credits
+-------
+

djaxei-0.0.0/TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+1. Add i18n support

djaxei-0.0.0/pyproject.toml

@@ -0,0 +1,68 @@
+[tool.poetry]
+name = "djaxei"
+version = "1.2.1"
+description = "A django admin extension for importing exporting records from/to xls/ods"
+authors = ["Giovanni Bronzini <g.bronzini@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/GigiusB/djaxei.git"
+keywords = ["xls",]
+include = ["README.md", "HISTORY.md", "Makefile"]
+packages = [
+    { include = "djaxei", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.8.7,<4"
+django = ">=3.2,<5"
+#openpyxl = { version = "<4", optional = true }
+#xlwt = {version = ">=1.2.0", optional = true}
+#xlsxwriter = {version = ">=1.2.8", optional = true}
+openpyxl = ">=3.0.0"
+
+#[tool.poetry.dev-dependencies]
+#pytest = "^6.2.5"
+#tox = "^3.24.4"
+#pytest-django = "^4.5.2"
+#factory-boy = "^3.2.1"
+#pytest-pythonpath = "^0.7.3"
+#flake8 = "^4.0.1"
+#isort = "^5.10.1"
+#django-webtest = "^1.9.8"
+#pytest-env = "^0.6.2"
+#pytest-coverage = "^0.0"
+#pytest-echo = "^1.7.1"
+
+#[tool.poetry.extras]
+#openpyxl = ["openpyxl"]
+#xlsxwriter = ["xlsxwriter"]
+#xlwt = ["xlwt"]
+
+#requires = ["poetry>=1.1"]
+#build-backend = "poetry.masonry.api"
+
+#[tool.poetry.group.dev.dependencies]
+#openpyxl = "^3.1.0"
+#xlsxwriter = "^3.0.7"
+pytz = "^2024.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "*"
+pytest-django = "*"
+flake8 = "*"
+isort = "*"
+bumpversion = "*"
+factory-boy = "*"
+pytest-env = "*"
+pytest-coverage = "*"
+pytest-echo = "*"
+tox = "*"
+
+
+[build-system]
+requires = [
+    "setuptools>=61",
+    "setuptools_scm[toml]>=6.2"
+]
+
+build-backend = "setuptools.build_meta"

djaxei-0.0.0/pytest.ini

@@ -0,0 +1,37 @@
+[pytest]
+env = 
+    DJANGO_SETTINGS_MODULE=demoproject.settings
+norecursedirs = data _plugin_template ~* .* node_modules
+pythonpath = ./src, ./tests/demo
+django_find_project = false
+;log_format = %(asctime)s %(levelname)s %(message)s
+;log_date_format = %Y-%m-%d %H:%M:%S
+;log_print = true
+log_cli = 0
+log_cli_level = INFO
+log_cli_format = [%(levelname)-8s] %(message)s (%(filename)s:%(lineno)s)
+log_cli_date_format=%Y-%m-%d %H:%M:%S
+addopts =
+        -rs
+        -p no:xdist
+        -p no:pep8
+        -p no:warnings
+        --reuse-db
+        --tb=short
+        --capture=no
+        --cov-report=html
+        --cov-config=tests/.coveragerc
+        --cov=djaxei
+        --echo-version=django
+
+markers =
+    plugin: dispatcher test
+    incremental: incremental tests
+    skipif_missing: skip test if environment variable does not exists
+    paid: paid plugin test
+    cli: CLI related tests
+    selenium: Run selenium functional tests
+
+python_files=test_*.py
+filterwarnings =
+    ignore::DeprecationWarning

djaxei-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

djaxei-0.0.0/src/djaxei/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.2.1"

djaxei-0.0.0/src/djaxei/actions.py

@@ -0,0 +1,100 @@
+from django.contrib import messages
+from django.contrib.admin import helpers
+from django.contrib.admin.utils import get_deleted_objects, model_ngettext
+from django.core.exceptions import PermissionDenied
+from django.db import router
+from django.template.response import TemplateResponse
+from django.utils.encoding import force_text
+from django.utils.translation import ugettext as _, ugettext_lazy
+
+
+def replace_selected_validator(modeladmin, request, queryset):
+    # Check that the user has delete permission for the actual model
+    if not modeladmin.has_delete_permission(request):
+        raise PermissionDenied
+    return None
+
+
+def replace_selected_factory(breadcrumb=None, validate_queryset=None):
+    def replace_selected(modeladmin, request, queryset):
+        """
+        Default action which deletes the selected objects.
+
+        This action first displays a confirmation page which shows all the
+        deletable objects, or, if the user has no permission one of the related
+        childs (foreignkeys), a "permission denied" message.
+
+        Next, it deletes all selected objects and redirects back to the change list.
+        """
+        opts = modeladmin.model._meta
+        app_label = opts.app_label
+
+        if not modeladmin.has_delete_permission(request):
+            raise PermissionDenied
+
+        if validate_queryset:
+            validation_error_message = validate_queryset(modeladmin, request, queryset)
+            if validation_error_message:
+                modeladmin.message_user(request, validation_error_message, messages.WARNING)
+                return None
+
+        using = router.db_for_write(modeladmin.model)
+
+        # Populate deletable_objects, a data structure of all related objects that
+        # will also be deleted.
+        deletable_objects, model_count, perms_needed, protected = get_deleted_objects(
+            queryset, opts, request.user, modeladmin.admin_site, using)
+
+        # The user has already confirmed the deletion.
+        # Do the deletion and return a None to display the change list view again.
+        if request.POST.get('post') and not protected:
+            if perms_needed:
+                raise PermissionDenied
+            n = queryset.count()
+            if n:
+                for obj in queryset:
+                    obj_display = force_text(obj)
+                    modeladmin.log_deletion(request, obj, obj_display)
+                queryset.delete()
+                modeladmin.message_user(request, _("Successfully deleted %(count)d %(items)s.") % {
+                    "count": n, "items": model_ngettext(modeladmin.opts, n)
+                }, messages.SUCCESS)
+            # Return None to display the change list page again.
+            return None
+
+        if len(queryset) == 1:
+            objects_name = force_text(opts.verbose_name)
+        else:
+            objects_name = force_text(opts.verbose_name_plural)
+
+        if perms_needed or protected:
+            title = _("Cannot delete %(name)s") % {"name": objects_name}
+        else:
+            title = _("Are you sure you want to replace those records with the content of the spreadsheet?")
+
+        context = dict(
+            modeladmin.admin_site.each_context(request),
+            title=title,
+            objects_name=objects_name,
+            deletable_objects=[deletable_objects],
+            model_count=dict(model_count).items(),
+            queryset=queryset,
+            perms_lacking=perms_needed,
+            protected=protected,
+            opts=opts,
+            action_checkbox_name=helpers.ACTION_CHECKBOX_NAME,
+            media=modeladmin.media,
+        )
+
+        request.current_app = modeladmin.admin_site.name
+
+        # Display the confirmation page
+        return TemplateResponse(request, modeladmin.delete_selected_confirmation_template or [
+            "admin/%s/%s/delete_selected_confirmation.html" % (app_label, opts.model_name),
+            "admin/%s/delete_selected_confirmation.html" % app_label,
+            "admin/delete_selected_confirmation.html"
+        ], context)
+
+    replace_selected.short_description = \
+        breadcrumb or ugettext_lazy("Replace %(verbose_name_plural)s with xls")
+    return replace_selected

djaxei-0.0.0/src/djaxei/admin.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.contrib import admin
+
+# Register your models here.

djaxei-0.0.0/src/djaxei/apps.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.apps import AppConfig
+
+
+class DjaxeiConfig(AppConfig):
+    name = 'djaxei'

djaxei-0.0.0/src/djaxei/exceptions.py

@@ -0,0 +1,13 @@
+class ImportException(Exception):
+    def __init__(self, cause, worksheet=None, *args):
+        super(ImportException, self).__init__(*args)
+        self.worksheet = worksheet
+        self.cause = cause
+
+    def __str__(self):
+        if hasattr(self.cause, 'reference'):
+            msg = "[%s:%s] %s: %s" % (self.worksheet, self.cause.reference, self.cause.__class__.__name__, str(self.cause))
+        else:
+            msg = "[%s] %s: %s" % (self.worksheet, self.cause.__class__.__name__, str(self.cause))
+        return msg
+