wbaccounting 2.2.1__tar.gz

wbaccounting-2.2.1/.gitignore

@@ -0,0 +1,181 @@
+~
+
+# Docker volumes
+volumes/
+# Poetry auth file
+auth.toml
+
+media/*
+media/
+mediafiles/
+mediafiles/*
+test/*
+staticfiles/*
+staticfiles/
+#
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+info/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+.dccache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+report.xml
+*/report.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+*.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.vscode/
+.idea/
+.idea.bkp/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+crm/
+# Cython debug symbols
+cython_debug/
+
+# Gitlab Runner
+builds
+builds/
+
+# Integrator Office 365 : reverse proxy tunnel for outlook365
+ngrok
+*/ngrok
+/modules/**/system/
+
+/modules/wbmailing/files/*
+/modules/wbmailing/mailing/*
+
+/projects/*/requirements.txt
+public
+
+# Ignore archive localization generated folder
+backend/modules/**/archive/*
+**/**/requirements.txt
+CHANGELOG-*

wbaccounting-2.2.1/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.3
+Name: wbaccounting
+Version: 2.2.1
+Summary: A workbench module for managing invoicing and simple accounting.
+Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
+Requires-Dist: reportlab==3.*
+Requires-Dist: schwifty==2024.5.*
+Requires-Dist: wbcore

wbaccounting-2.2.1/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "wbaccounting"
+description = "A workbench module for managing invoicing and simple accounting."
+authors = [{ name = "Christopher Wittlinger", email = "c.wittlinger@stainly.com"}]
+dynamic = ["version"]
+
+dependencies = [
+  "wbcore",
+  "reportlab == 3.*",
+  "schwifty == 2024.5.*",
+]
+
+[tool.uv.sources]
+wbcore = { workspace = true }
+
+[tool.uv]
+package = true
+
+[tool.hatch.version]
+path = "../../pyproject.toml"
+
+[tool.hatch.build.targets.sdist]
+include = ["wbaccounting/*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["wbaccounting"]
+only-packages = true
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

wbaccounting-2.2.1/wbaccounting/__init__.py

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

wbaccounting-2.2.1/wbaccounting/admin/__init__.py

@@ -0,0 +1,5 @@
+from .booking_entry import BookingEntryInline, BookingEntryModelAdmin
+from .entry_accounting_information import EntryAccountingInformationModelAdmin
+from .invoice_type import InvoiceTypeModelAdmin
+from .invoice import InvoiceModelAdmin
+from .transactions import TransactionModelAdmin

wbaccounting-2.2.1/wbaccounting/admin/booking_entry.py

@@ -0,0 +1,53 @@
+from datetime import date
+
+from django.contrib import admin
+from wbaccounting.models import BookingEntry, Invoice
+from wbcore.contrib.directory.models import Entry
+
+
+class BookingEntryInline(admin.TabularInline):
+    model = BookingEntry
+    fields = ("booking_date", "net_value", "vat")
+    ordering = ("vat", "title")
+
+    def has_add_permission(self, request, obj=None):
+        return False
+
+
+@admin.register(BookingEntry)
+class BookingEntryModelAdmin(admin.ModelAdmin):
+    list_display = (
+        "title",
+        "booking_date",
+        "net_value",
+        "vat",
+        "currency",
+        "payment_date",
+        "counterparty",
+        "reference_date",
+    )
+    search_fields = ["counterparty__computed_str"]
+    autocomplete_fields = ("counterparty", "currency")
+
+    # TODO: Remove or adjust.
+    def create_invoice(self, request, queryset):
+        counterparty = list(set(queryset.values_list("counterparty__id", flat=True)))
+        if len(counterparty) == 1:
+            counterparty = Entry.objects.get(id=counterparty[0])
+            invoice = Invoice.objects.create(
+                title=f"Rebate Invoice {counterparty.computed_str} ({queryset.earliest('from_date').from_date:%d.%m.%Y} - {queryset.latest('to_date').to_date:%d.%m.%Y})",
+                invoice_date=date.today(),
+                reference_date=date.today(),
+                counterparty=counterparty,
+                invoice_currency=counterparty.entry_accounting_information.default_currency,
+                is_counterparty_invoice=True,
+            )
+            queryset.update(invoice=invoice)
+            invoice.save()
+
+        else:
+            print("-------------------------------")  # noqa: T201
+            print(f"Too many counterparties selected ({len(counterparty)})")  # noqa: T201
+            print("-------------------------------")  # noqa: T201
+
+    actions = [create_invoice]

wbaccounting-2.2.1/wbaccounting/admin/entry_accounting_information.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+from wbaccounting.models import EntryAccountingInformation
+
+
+@admin.register(EntryAccountingInformation)
+class EntryAccountingInformationModelAdmin(admin.ModelAdmin):
+    list_display = ("entry", "send_mail", "counterparty_is_private")
+    autocomplete_fields = ["default_currency", "entry", "email_to", "email_cc", "email_bcc", "exempt_users"]
+
+    search_fields = ["entry__computed_str"]

wbaccounting-2.2.1/wbaccounting/admin/invoice.py

@@ -0,0 +1,26 @@
+from django.contrib import admin
+from wbaccounting.admin import BookingEntryInline
+from wbaccounting.models import Invoice
+from wbcore.contrib.documents.admin import DocumentInLine
+
+
+@admin.register(Invoice)
+class InvoiceModelAdmin(admin.ModelAdmin):
+    fsm_field = ["status"]
+    search_fields = ("counterparty__computed_str", "title", "invoice_type__name")
+    list_display = (
+        "status",
+        "title",
+        "gross_value",
+        "net_value",
+        "invoice_date",
+        "invoice_currency",
+        "counterparty",
+        "invoice_type",
+        "reference_date",
+    )
+
+    autocomplete_fields = ("counterparty",)
+    inlines = [BookingEntryInline, DocumentInLine]
+
+    raw_id_fields = ["counterparty", "invoice_currency", "invoice_type"]

wbaccounting-2.2.1/wbaccounting/admin/invoice_type.py

@@ -0,0 +1,8 @@
+from django.contrib import admin
+from wbaccounting.models import InvoiceType
+
+
+@admin.register(InvoiceType)
+class InvoiceTypeModelAdmin(admin.ModelAdmin):
+    search_fields = ("name", "processor")
+    list_display = ("id", "name", "processor")

wbaccounting-2.2.1/wbaccounting/admin/transactions.py

@@ -0,0 +1,16 @@
+from django.contrib import admin
+from wbaccounting.models import Transaction
+
+
+@admin.register(Transaction)
+class TransactionModelAdmin(admin.ModelAdmin):
+    list_display = ["booking_date", "value_date", "value", "bank_account", "prenotification"]
+
+    raw_id_fields = ["import_source"]
+
+    autocomplete_fields = [
+        "bank_account",
+        "from_bank_account",
+        "to_bank_account",
+        "currency",
+    ]

wbaccounting-2.2.1/wbaccounting/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class WbaccountingConfig(AppConfig):
+    name = "wbaccounting"

wbaccounting-2.2.1/wbaccounting/dynamic_preferences_registry.py

@@ -0,0 +1,107 @@
+from django.conf import settings
+from dynamic_preferences.preferences import Section
+from dynamic_preferences.registries import global_preferences_registry
+from dynamic_preferences.types import (
+    IntegerPreference,
+    LongStringPreference,
+    ModelMultipleChoicePreference,
+    StringPreference,
+)
+from wbcore.contrib.currency.models import Currency
+from wbcore.contrib.directory.models import Person
+
+accounting_section = Section("wbaccounting")
+
+
+def format_invoice_number(number):
+    global_preferences = global_preferences_registry.manager()
+    ts = global_preferences["wbaccounting__invoice_thousand_seperator"]
+    ds = global_preferences["wbaccounting__invoice_decimal_seperator"]
+    if not number:
+        number = 0
+    s = "{:,.2f}".format(number)
+    s = s.replace(",", "//")
+    s = s.replace(".", "\\")
+
+    return s.replace("//", ts).replace("\\", ds)
+
+
+@global_preferences_registry.register
+class DefaultEntryAccountingInformationCurrency(StringPreference):
+    section = accounting_section
+    name = "default_entry_account_information_currency_key"
+    default = "CHF"
+
+    verbose_name = "The currency key used for the default currency of newly created entry accounting informations."
+
+    def validate(self, value):
+        if not Currency.objects.filter(key=value).exists():
+            return ValueError("The specified currency key is not valid")
+
+
+@global_preferences_registry.register
+class ExternalEmailAddress(StringPreference):
+    section = accounting_section
+    name = "external_email_address"
+    default = ""
+
+    verbose_name = "External Email Address"
+    help_text = "The Email Address used to send Invoices to the external party."
+
+
+@global_preferences_registry.register
+class InvoiceEmailBody(LongStringPreference):
+    section = accounting_section
+    name = "invoice_email_body"
+    default = ""
+
+    verbose_name = "The default E-Mail Body used for emailing Invoices"
+
+
+@global_preferences_registry.register
+class InvoiceThousandSeperatorPreference(StringPreference):
+    section = accounting_section
+    name = "invoice_thousand_seperator"
+    default = ","
+
+    verbose_name = "Invoice Thousand Seperator"
+    help_text = "Thousand Seperator for Invoices"
+
+
+@global_preferences_registry.register
+class InvoiceDecimalSeperatorPreference(StringPreference):
+    section = accounting_section
+    name = "invoice_decimal_seperator"
+    default = "."
+
+    verbose_name = "Invoice Decimal Seperator"
+    help_text = "Decimal Seperator for Invoices"
+
+
+@global_preferences_registry.register
+class InvoiceSignerPreference(ModelMultipleChoicePreference):
+    section = accounting_section
+    name = "invoice_signers"
+    queryset = Person.objects.all()
+    default = None
+    verbose_name = "Invoice Signers"
+
+
+@global_preferences_registry.register
+class InvoiceCompanyPreference(IntegerPreference):
+    section = accounting_section
+    name = "invoice_company"
+    default = 0
+
+    verbose_name = "Invoice Company"
+    help_text = "The PK of the company who issues the invoices"
+
+
+@global_preferences_registry.register
+class DefaultFromEmailAddressPreference(StringPreference):
+    section = accounting_section
+    name = "default_from_email_address"
+    default = settings.DEFAULT_FROM_EMAIL
+
+    verbose_name = "The default from email address"
+    help_text = "The default from email address used to send invoice"

wbaccounting-2.2.1/wbaccounting/factories/__init__.py

@@ -0,0 +1,10 @@
+from .booking_entry import BookingEntryFactory
+from .entry_accounting_information import (
+    CompanyAccountingFactory,
+    EntryAccountingInformationFactory,
+)
+from .invoice import (
+    InvoiceFactory,
+    InvoiceTypeFactory,
+)
+from .transactions import TransactionFactory, LocalCurrencyTransactionFactory

wbaccounting-2.2.1/wbaccounting/factories/booking_entry.py

@@ -0,0 +1,21 @@
+import factory
+from factory.fuzzy import FuzzyDecimal
+from wbaccounting.models import BookingEntry
+
+
+class BookingEntryFactory(factory.django.DjangoModelFactory):
+    class Meta:  # type: ignore
+        model = BookingEntry
+
+    # resolved
+    title = factory.Faker("text", max_nb_chars=64)
+    booking_date = factory.Faker("date_between", start_date="+2d", end_date="+3d")
+    payment_date = factory.Faker("date_object")
+    reference_date = factory.Faker("date_object")
+    gross_value = factory.Faker("pydecimal", right_digits=4, min_value=0, max_value=99999999999)
+    net_value = factory.Faker("pydecimal", right_digits=4, min_value=0, max_value=99999999999)
+    vat = FuzzyDecimal(0, 0.9, 4)
+    currency = factory.SelfAttribute("invoice.invoice_currency")
+
+    invoice = factory.SubFactory("wbaccounting.factories.InvoiceFactory")
+    counterparty = factory.SubFactory("wbcore.contrib.directory.factories.EntryFactory")

wbaccounting-2.2.1/wbaccounting/factories/entry_accounting_information.py

@@ -0,0 +1,46 @@
+import factory
+from factory.fuzzy import FuzzyDecimal
+from wbaccounting.models import EntryAccountingInformation
+from wbcore.contrib.directory.factories import CompanyFactory, EmailContactFactory
+
+
+class EntryAccountingInformationFactory(factory.django.DjangoModelFactory):
+    class Meta:  # type: ignore
+        model = EntryAccountingInformation
+
+    entry = factory.SubFactory("wbcore.contrib.directory.factories.EntryFactory")
+    tax_id = factory.Faker("text", max_nb_chars=64)
+    vat = FuzzyDecimal(0, 0.9, 4)
+    send_mail = factory.Faker("pybool")
+    counterparty_is_private = False
+
+    email_body = factory.Faker("paragraph")
+
+    @factory.post_generation
+    def post(self, create, extracted, **kwargs):
+        if isinstance(self, EntryAccountingInformationFactory) and not create:
+            self.email_to.add(EmailContactFactory.create())
+            self.email_cc_add(EmailContactFactory.create())
+            self.email_bcc.add(EmailContactFactory.create())
+
+        if isinstance(self, dict):
+            self["email_to"] = [EmailContactFactory.create().id]
+            self["email_cc"] = [EmailContactFactory.create().id]
+            self["email_bcc"] = [EmailContactFactory.create().id]
+
+    @factory.post_generation
+    def exempt_users(self, create, extracted, **kwargs):
+        if not create:
+            return
+
+        if extracted:
+            for user in extracted:
+                self.exempt_users.add(user)
+
+    default_currency = factory.SubFactory("wbcore.contrib.currency.factories.CurrencyFactory")
+
+
+class CompanyAccountingFactory(CompanyFactory):
+    entry_accounting_information = factory.RelatedFactory(
+        "wbaccounting.factories.EntryAccountingInformationFactory", "entry"
+    )

wbaccounting-2.2.1/wbaccounting/factories/invoice.py

@@ -0,0 +1,43 @@
+import factory
+from wbaccounting.models import Invoice, InvoiceType
+
+
+class InvoiceFactory(factory.django.DjangoModelFactory):
+    class Meta:  # type: ignore
+        model = Invoice
+
+    title = factory.Faker("text", max_nb_chars=64)
+    invoice_date = factory.Faker("date_object")
+    reference_date = factory.Faker("date_object")
+    invoice_currency = factory.SubFactory("wbcore.contrib.currency.factories.CurrencyUSDFactory")
+
+    counterparty = factory.SubFactory("wbcore.contrib.directory.factories.EntryFactory")
+    invoice_type = factory.SubFactory("wbaccounting.factories.InvoiceTypeFactory")
+
+    text_above = factory.Faker("text")
+    text_below = factory.Faker("text")
+
+    # @factory.post_generation
+    # def invoice_document(self, create, extracted, **kwargs):
+    #     self.refresh_invoice_document(override_status=True)
+
+    # is_counterparty_invoice
+
+    # @classmethod
+    # def _create(cls, model_class, *args, **kwargs):
+    #     company = CompanyFactory()
+    #     signee = PersonSignatureFactory()
+    #     global_preferences_registry.manager()["wbaccounting__invoice_company"] = company.id
+    #     global_preferences_registry.manager()["wbaccounting__invoice_signers"] = Person.objects.filter(id=signee.id)
+    #     """Override the default ``_create`` with our custom call."""
+    #     manager = cls._get_manager(model_class)
+    #     # The default would use ``manager.create(*args, **kwargs)``
+    #     return manager.create(*args, **kwargs)
+
+
+class InvoiceTypeFactory(factory.django.DjangoModelFactory):
+    name = factory.Sequence(lambda n: f"Invoice Type {n}")
+    processor = factory.Faker("text", max_nb_chars=64)
+
+    class Meta:  # type: ignore
+        model = InvoiceType

wbaccounting-2.2.1/wbaccounting/factories/transactions.py

@@ -0,0 +1,32 @@
+from decimal import Decimal
+
+import factory
+from wbaccounting.models import Transaction
+
+
+class AbstractTransactionFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = Transaction
+        abstract = True
+
+    booking_date = factory.Faker("date_between", start_date="+2d", end_date="+3d")
+    value_date = factory.Faker("date_object")
+
+    bank_account = factory.SubFactory("wbcore.contrib.directory.factories.BankingContactFactory")
+    from_bank_account = factory.SubFactory("wbcore.contrib.directory.factories.BankingContactFactory")
+    to_bank_account = factory.SubFactory("wbcore.contrib.directory.factories.BankingContactFactory")
+
+    @factory.post_generation
+    def set_currency(self, create, extracted, **kwargs):
+        if isinstance(self, dict):
+            self["currency"] = self["bank_account"].currency
+        else:
+            self.currency = self.bank_account.currency
+
+
+class TransactionFactory(AbstractTransactionFactory):
+    value = factory.Faker("pydecimal", min_value=Decimal(0.1), max_value=Decimal(10000000))
+
+
+class LocalCurrencyTransactionFactory(AbstractTransactionFactory):
+    value_local_ccy = factory.Faker("pydecimal", min_value=Decimal(0.1), max_value=Decimal(10000000))