initial commit

.gitignore

@@ -0,0 +1,2 @@
+env/
+.idea/

LICENSE.md

@@ -0,0 +1,483 @@
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS
+COOPERATIVE NON-VIOLENT PUBLIC LICENSE (\"LICENSE\"). THE WORK IS
+PROTECTED BY COPYRIGHT AND ALL OTHER APPLICABLE LAWS. ANY USE OF THE
+WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS
+PROHIBITED. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED IN THIS
+LICENSE, YOU AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE.TO THE
+EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR
+GRANTS YOU THE RIGHTS CONTAINED HERE IN AS CONSIDERATION FOR ACCEPTING
+THE TERMS AND CONDITIONS OF THIS LICENSE AND FOR AGREEING TO BE BOUND BY
+THE TERMS AND CONDITIONS OF THIS LICENSE.
+
+# Definitions
+
+An Act of War is any action of one country against any group either with
+an intention to provoke a conflict or an action that occurs during a
+declared war or during armed conflict between military forces of any
+origin. This includes but is not limited to enforcing sanctions or
+sieges, supplying armed forces, or profiting from the manufacture of
+tools or weaponry used in military conflict.
+
+An Adaptation is a work based upon the Work, or upon the Work and other
+pre-existing works, such as a translation, adaptation, derivative work,
+arrangement of music or other alterations of a literary or artistic
+work, or phonogram or performance and includes cinematographic
+adaptations or any other form in which the Work may be recast,
+transformed, or adapted including in any form recognizably derived from
+the original, except that a work that constitutes a Collection will not
+be considered an Adaptation for the purpose of this License. For the
+avoidance of doubt, where the Work is a musical work, performance or
+phonogram, the synchronization of the Work in timed-relation with a
+moving image (\"synching\") will be considered an Adaptation for the
+purpose of this License. In addition, where the Work is designed to
+output a neural network the output of the neural network will be
+considered an Adaptation for the purpose of this license.
+
+Bodily Harm is any physical hurt or injury to a person that interferes
+with the health or comfort of the person and that is more than merely
+transient or trifling in nature.
+
+Distribute is to make available to the public the original and copies of
+the Work or Adaptation, as appropriate, through sale, gift or any other
+transfer of possession or ownership.
+
+Incarceration is Confinement in a jail, prison, or any other place where
+individuals of any kind are held against either their will or (if their
+will cannot be determined) the will of their legal guardian or
+guardians. In the case of a conflict between the will of the individual
+and the will of their legal guardian or guardians, the will of the
+individual will take precedence.
+
+Licensor is The individual, individuals, entity, or entities that
+offer(s) the Work under the terms of this License
+
+Original Author is in the case of a literary or artistic work, the
+individual, individuals, entity or entities who created the Work or if
+no individual or entity can be identified, the publisher; and in
+addition
+
+-   in the case of a performance the actors, singers, musicians,
+    dancers, and other persons who act, sing, deliver, declaim, play in,
+    interpret or otherwise perform literary or artistic works or
+    expressions of folklore;
+
+-   in the case of a phonogram the producer being the person or legal
+    entity who first fixes the sounds of a performance or other sounds;
+    and,
+
+-   in the case of broadcasts, the organization that transmits the
+    broadcast.
+
+Work is the literary and/or artistic work offered under the terms of
+this License including without limitation any production in the
+literary, scientific and artistic domain, whatever may be the mode or
+form of its expression including digital form, such as a book, pamphlet
+and other writing; a lecture, address, sermon or other work of the same
+nature; a dramatic or dramatico-musical work; a choreographic work or
+entertainment in dumb show; a musical composition with or without words;
+a cinematographic work to which are assimilated works expressed by a
+process analogous to cinematography; a work of drawing, painting,
+architecture, sculpture, engraving or lithography; a photographic work
+to which are assimilated works expressed by a process analogous to
+photography; a work of applied art; an illustration, map, plan, sketch
+or three-dimensional work relative to geography, topography,
+architecture or science; a performance; a broadcast; a phonogram; a
+compilation of data to the extent it is protected as a copyrightable
+work; or a work performed by a variety or circus performer to the extent
+it is not otherwise considered a literary or artistic work.
+
+You means an individual or entity exercising rights under this License
+who has not previously violated the terms of this License with respect
+to the Work, or who has received express permission from the Licensor to
+exercise rights under this License despite a previous violation.
+
+Publicly Perform means to perform public recitations of the Work and to
+communicate to the public those public recitations, by any means or
+process, including by wire or wireless means or public digital
+performances; to make available to the public Works in such a way that
+members of the public may access these Works from a place and at a place
+individually chosen by them; to perform the Work to the public by any
+means or process and the communication to the public of the performances
+of the Work, including by public digital performance; to broadcast and
+rebroadcast the Work by any means including signs, sounds or images.
+
+Reproduce is to make copies of the Work by any means including without
+limitation by sound or visual recordings and the right of fixation and
+reproducing fixations of the Work, including storage of a protected
+performance or phonogram in digital form or other electronic medium.
+
+Software is any digital Work which, through use of a third-party piece
+of Software or through the direct usage of itself on a computer system,
+the memory of the computer is modified dynamically or semi-dynamically.
+\"Software\", secondly, processes or interprets information.
+
+Source Code is Any digital Work which, through use of a third-party
+piece of Software or through the direct usage of itself on a computer
+system, the memory of the computer is modified dynamically or
+semi-dynamically. \"Software\", secondly, processes or interprets
+information.
+
+Surveilling is the use of the Work to either overtly or covertly observe
+and record persons and or their activities.
+
+A Network Service is the use of a piece of Software to interpret or
+modify information that is subsequently and directly served to users
+over the Internet.
+
+To Discriminate is the use of a piece of Software to interpret or modify
+information that is subsequently and directly served to users over the
+Internet.
+
+Hate Speech is Communication or any form of expression which is solely
+for the purpose of expressing hatred for some group or advocating a form
+of Discrimination between humans.
+
+Coercion is leveraging of the threat of force or use of force to
+intimidate a person in order to gain compliance, or to offer large
+incentives which aim to entice a person to act against their will.
+
+# Fair Dealing Rights
+
+Nothing in this License is intended to reduce, limit, or restrict any
+uses free from copyright or rights arising from limitations or
+exceptions that are provided for in connection with the copyright
+protection under copyright law or other applicable laws.
+
+# License Grant
+
+Subject to the terms and conditions of this License, Licensor hereby
+grants You a worldwide, royalty-free, non-exclusive, perpetual (for the
+duration of the applicable copyright) license to exercise the rights in
+the Work as stated below:
+
+To Reproduce the Work, to incorporate the Work into one or more
+Collections, and to Reproduce the Work as incorporated in the
+Collections
+
+To create and Reproduce Adaptations provided that any such Adaptation,
+including any translation in any medium, takes reasonable steps to
+clearly label, demarcate or otherwise identify that changes were made to
+the original Work. For example, a translation could be marked \"The
+original work was translated from English to Spanish,\" or a
+modification could indicate \"The original work has been modified.\"
+
+To Distribute and Publicly Perform the Work including as incorporated in
+Collections.
+
+To Distribute and Publicly Perform Adaptations. The above rights may be
+exercised in all media and formats whether now known or hereafter
+devised. The above rights include the right to make such modifications
+as are technically necessary to exercise the rights in other media and
+formats. This License constitutes the entire agreement between the
+parties with respect to the Work licensed here. There are no
+understandings, agreements or representations with respect to the Work
+not specified here. Licensor shall not be bound by any additional
+provisions that may appear in any communication from You. This License
+may not be modified without the mutual written agreement of the Licensor
+and You. All rights not expressly granted by Licensor are hereby
+reserved, including but not limited to the rights set forth in
+Non-waivable Compulsory License Schemes, Waivable Compulsory License
+Schemes, and Voluntary License Schemes in the restrictions.
+
+# Restrictions
+
+The license granted in the license grant above is expressly made subject
+to and limited by the following restrictions:
+
+You may Distribute or Publicly Perform the Work only under the terms of
+this License. You must include a copy of, or the Uniform Resource
+Identifier (URI) for, this License with every copy of the Work You
+Distribute or Publicly Perform. You may not offer or impose any terms on
+the Work that restrict the terms of this License or the ability of the
+recipient of the Work to exercise the rights granted to that recipient
+under the terms of the License. You may not sublicense the Work. You
+must keep intact all notices that refer to this License and to the
+disclaimer of warranties with every copy of the Work You Distribute or
+Publicly Perform. When You Distribute or Publicly Perform the Work, You
+may not impose any effective technological measures on the Work that
+restrict the ability of a recipient of the Work from You to exercise the
+rights granted to that recipient under the terms of the License. This
+Section applies to the Work as incorporated in a Collection, but this
+does not require the Collection apart from the Work itself to be made
+subject to the terms of this License. If You create a Collection, upon
+notice from any Licensor You must, to the extent practicable, remove
+from the Collection any credit as requested. If You create an
+Adaptation, upon notice from any Licensor You must, to the extent
+practicable, remove from the Adaptation any credit as requested.
+
+## Commercial Restrictions
+
+You may not exercise any of the rights granted to You in the above
+section in any manner that is primarily intended for or directed toward
+commercial advantage or private monetary compensation unless you meet
+the following requirements.
+
+i.  You are a worker-owned business or worker-owned collective.
+
+ii. after tax, all financial gain, surplus, profits and benefits
+    produced by the business or collective are distributed among the
+    worker-owners unless a set amount is to be allocated towards
+    community projects as decided by a previously-established consensus
+    agreement between the worker-owners where all worker-owners agreed.
+
+iii. You are not using such rights on behalf of a business other than
+     those specified in (i) or (ii) above, nor are using such rights as
+     a proxy on behalf of a business with the intent to circumvent the
+     aforementioned restrictions on such a business.
+
+The exchange of the Work for other copyrighted works by means of digital
+file-sharing or otherwise shall not be considered to be intended for or
+directed toward commercial advantage or private monetary compensation,
+provided there is no payment of any monetary compensation in connection
+with the exchange of copyrighted works.
+
+If the Work meets the definition of Software, You may exercise the
+rights granted in the license grant only if You provide a copy of the
+corresponding Source Code from which the Work was derived in digital
+form, or You provide a URI for the corresponding Source Code of the
+Work, to any recipients upon request.
+
+If the Work is used as or for a Network Service, You may exercise the
+rights granted in the license grant only if You provide a copy of the
+corresponding Source Code from which the Work was derived in digital
+form, or You provide a URI for the corresponding Source Code to the
+Work, to any recipients of the data served or modified by the Web
+Service.
+
+Any use by a business that is privately owned and managed, and that
+seeks to generate profit from the labor of employees paid by salary or
+other wages, is not permitted under this license.
+
+##
+
+You may exercise the rights granted in the license grant for any
+purposes only if:
+
+i.  You do not use the Work for the purpose of inflicting Bodily Harm on
+    human beings (subject to criminal prosecution or otherwise) outside
+    of providing medical aid or undergoing a voluntary procedure under
+    no form of Coercion.
+
+ii. You do not use the Work for the purpose of Surveilling or tracking
+    individuals for financial gain.
+
+iii. You do not use the Work in an Act of War.
+
+iv. You do not use the Work for the purpose of supporting or profiting
+    from an Act of War.
+
+v.  You do not use the Work for the purpose of Incarceration.
+
+vi. You do not use the Work for the purpose of extracting, processing,
+    or refining, oil, gas, or coal. Or to in any other way to
+    deliberately pollute the environment as a byproduct of manufacturing
+    or irresponsible disposal of hazardous materials.
+
+vii. You do not use the Work for the purpose of expediting,
+     coordinating, or facilitating paid work undertaken by individuals
+     under the age of 12 years.
+
+viii. You do not use the Work to either Discriminate or spread Hate
+      Speech on the basis of sex, sexual orientation, gender identity,
+      race, age, disability, color, national origin, religion, caste, or
+      lower economic status.
+
+##
+
+If You Distribute, or Publicly Perform the Work or any Adaptations or
+Collections, You must, unless a request has been made by any Licensor to
+remove credit from a Collection or Adaptation, keep intact all copyright
+notices for the Work and provide, reasonable to the medium or means You
+are utilizing:
+
+i.  the name of the Original Author (or pseudonym, if applicable) if
+    supplied, and/or if the Original Author and/or Licensor designate
+    another party or parties (e.g., a sponsor institute, publishing
+    entity, journal) for attribution (\"Attribution Parties\") in
+    Licensor\'s copyright notice, terms of service or by other
+    reasonable means, the name of such party or parties;
+
+ii. the title of the Work if supplied;
+
+iii. to the extent reasonably practicable, the URI, if any, that
+     Licensor to be associated with the Work, unless such URI does not
+     refer to the copyright notice or licensing information for the
+     Work; and,
+
+iv. in the case of an Adaptation, a credit identifying the use of the
+    Work in the Adaptation (e.g., \"French translation of the Work by
+    Original Author,\" or \"Screenplay based on original Work by
+    Original Author\").
+
+If any Licensor has sent notice to request removing credit, You must, to
+the extent practicable, remove any credit as requested. The credit
+required by this Section may be implemented in any reasonable manner;
+provided, however, that in the case of an Adaptation or Collection, at a
+minimum such credit will appear, if a credit for all contributing
+authors of the Adaptation or Collection appears, then as part of these
+credits and in a manner at least as prominent as the credits for the
+other contributing authors. For the avoidance of doubt, You may only use
+the credit required by this Section for the purpose of attribution in
+the manner set out above and, by exercising Your rights under this
+License, You may not implicitly or explicitly assert or imply any
+connection with, sponsorship or endorsement by the Original Author,
+Licensor and/or Attribution Parties, as appropriate, of You or Your use
+of the Work, without the separate, express prior written permission of
+the Original Author, Licensor and/or Attribution Parties.
+
+Non-waivable Compulsory License Schemes. In those jurisdictions in which
+the right to collect royalties through any statutory or compulsory
+licensing scheme cannot be waived, the Licensor reserves the exclusive
+right to collect such royalties for any exercise by You of the rights
+granted under this License
+
+Waivable Compulsory License Schemes. In those jurisdictions in which the
+right to collect royalties through any statutory or compulsory licensing
+scheme can be waived, the Licensor reserves the exclusive right to
+collect such royalties for any exercise by You of the rights granted
+under this License if Your exercise of such rights is for a purpose or
+use which is otherwise than noncommercial as permitted under Commercial
+Restrictions and otherwise waives the right to collect royalties through
+any statutory or compulsory licensing scheme.
+
+Voluntary License Schemes. The Licensor reserves the right to collect
+royalties, whether individually or, in the event that the Licensor is a
+member of a collecting society that administers voluntary licensing
+schemes, via that society, from any exercise by You of the rights
+granted under this License that is for a purpose or use which is
+otherwise than noncommercial as permitted under the license grant.
+
+Except as otherwise agreed in writing by the Licensor or as may be
+otherwise permitted by applicable law, if You Reproduce, Distribute or
+Publicly Perform the Work either by itself or as part of any Adaptations
+or Collections, You must not distort, mutilate, modify or take other
+derogatory action in relation to the Work which would be prejudicial to
+the Original Author\'s honor or reputation. Licensor agrees that in
+those jurisdictions (e.g. Japan), in which any exercise of the right
+granted in the license grant of this License (the right to make
+Adaptations) would be deemed to be a distortion, mutilation,
+modification or other derogatory action prejudicial to the Original
+Author\'s honor and reputation, the Licensor will waive or not assert,
+as appropriate, this Section, to the fullest extent permitted by the
+applicable national law, to enable You to reasonably exercise Your right
+under the license grant of this License (right to make Adaptations) but
+not otherwise.
+
+Do not make any legal claim against anyone accusing the Work, with or
+without changes, alone or with other works, of infringing any patent
+claim.
+
+# Representations Warranties and Disclaimer
+
+UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR
+OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY
+KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE,
+INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY,
+FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF
+LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS,
+WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE
+EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
+
+# Limitation on Liability
+
+EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL
+LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL,
+INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF
+THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGES.
+
+# Termination
+
+This License and the rights granted hereunder will terminate
+automatically upon any breach by You of the terms of this License.
+Individuals or entities who have received Adaptations or Collections
+from You under this License, however, will not have their licenses
+terminated provided such individuals or entities remain in full
+compliance with those licenses. The Sections on definitions, fair
+dealing rights, representations, warranties, and disclaimer, limitation
+on liability, termination, and revised license versions will survive any
+termination of this License.
+
+Subject to the above terms and conditions, the license granted here is
+perpetual (for the duration of the applicable copyright in the Work).
+Notwithstanding the above, Licensor reserves the right to release the
+Work under different license terms or to stop distributing the Work at
+any time; provided, however that any such election will not serve to
+withdraw this License (or any other license that has been, or is
+required to be, granted under the terms of this License), and this
+License will continue in full force and effect unless terminated as
+stated above.
+
+# Revised License Versions
+
+This License may receive future revisions in the original spirit of the
+license intended to strengthen This License. Each version of This
+License has an incrementing version number.
+
+Unless otherwise specified like in the below subsection The Licensor has
+only granted this current version of This License for The Work. In this
+case future revisions do not apply.
+
+The Licensor may specify that the latest available revision of This
+License be used for The Work by either explicitly writing so or by
+suffixing the License URI with a \"+\" symbol.
+
+The Licensor may specify that The Work is also available under the terms
+of This License\'s current revision as well as specific future
+revisions. The Licensor may do this by writing it explicitly or
+suffixing the License URI with any additional version numbers each
+separated by a comma.
+
+# Miscellaneous
+
+Each time You Distribute or Publicly Perform the Work or a Collection,
+the Licensor offers to the recipient a license to the Work on the same
+terms and conditions as the license granted to You under this License.
+
+Each time You Distribute or Publicly Perform an Adaptation, Licensor
+offers to the recipient a license to the original Work on the same terms
+and conditions as the license granted to You under this License.
+
+If the Work is classified as Software, each time You Distribute or
+Publicly Perform an Adaptation, Licensor offers to the recipient a copy
+and/or URI of the corresponding Source Code on the same terms and
+conditions as the license granted to You under this License.
+
+If the Work is used as a Network Service, each time You Distribute or
+Publicly Perform an Adaptation, or serve data derived from the Software,
+the Licensor offers to any recipients of the data a copy and/or URI of
+the corresponding Source Code on the same terms and conditions as the
+license granted to You under this License.
+
+If any provision of this License is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this License, and without further action
+by the parties to this agreement, such provision shall be reformed to
+the minimum extent necessary to make such provision valid and
+enforceable.
+
+No term or provision of this License shall be deemed waived and no
+breach consented to unless such waiver or consent shall be in writing
+and signed by the party to be charged with such waiver or consent.
+
+This License constitutes the entire agreement between the parties with
+respect to the Work licensed here. There are no understandings,
+agreements or representations with respect to the Work not specified
+here. Licensor shall not be bound by any additional provisions that may
+appear in any communication from You. This License may not be modified
+without the mutual written agreement of the Licensor and You.
+
+The rights granted under, and the subject matter referenced, in this
+License were drafted utilizing the terminology of the Berne Convention
+for the Protection of Literary and Artistic Works (as amended on
+September 28, 1979), the Rome Convention of 1961, the WIPO Copyright
+Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and
+the Universal Copyright Convention (as revised on July 24, 1971). These
+rights and subject matter take effect in the relevant jurisdiction in
+which the License terms are sought to be enforced according to the
+corresponding provisions of the implementation of those treaty
+provisions in the applicable national law. If the standard suite of
+rights granted under applicable copyright law includes additional rights
+not granted under this License, such additional rights are deemed to be
+included in the License; this License is not intended to restrict the
+license of any rights under applicable law.

setup.py

@@ -0,0 +1,21 @@
+from setuptools import setup
+
+long_description = """
+A simple collection of python packages used in various projects.
+
+Anything that I repeatedly implement probably ends up in here.
+"""
+
+setup(
+    name='xenua',
+    version='0.1.0',
+    description='Miscellaneous functions that are sometimes helpful',
+    long_description=long_description,
+    long_description_content_type='text/plain',
+    author='xenua',
+    author_email='python@xenua.me',
+    url='git.julia.network/julia/xenua_tools',
+    license='CNPLv7+',
+    python_requires='>=3.8',
+    packages=['xenua', 'xenua.django'],
+)

xenua/__init__.py

@@ -0,0 +1,6 @@
+from .decorators import no_op
+from .secrets import load_or_gen_secret, gen_secret
+from .types import Vec2
+from .utils import LayeredObject, import_module
+
+__all__ = ['no_op', 'Vec2', 'gen_secret', 'load_or_gen_secret', 'LayeredObject', 'import_module']

xenua/decorators.py

@@ -0,0 +1,5 @@
+
+
+def no_op(f: callable):
+    return f
+

xenua/django/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class XenuaConfig(AppConfig):
+    name = 'xenua.django'
+    verbose_name = _('xenua django extensions')

xenua/django/decorators.py

@@ -0,0 +1,18 @@
+
+try:
+    from django_scopes import scope
+except ImportError:
+    from xenua.decorators import no_op as scope
+
+
+def add_scopes(get_scopes=None, **scopes):
+    def decorate(fn):
+        def wrapper(*args, **kwargs):
+            nonlocal scopes
+            if get_scopes is not None:
+                scopes = get_scopes(**scopes)
+            with scope(**scopes):
+                return fn(*args, **kwargs)
+        return wrapper
+    return decorate
+

xenua/django/middleware.py

@@ -0,0 +1,38 @@
+from django.http import HttpResponse
+
+try:
+    from django_scopes import scope
+except ImportError:
+    from contextlib import nullcontext as scope
+
+
+class UserScopeMiddleware:
+    """
+    if django_scopes is installed, wrap the current view into a scope of user=request.user
+    override scope_condition to make it conditional
+    must be after AuthenticationMiddleware
+    """
+
+    @staticmethod
+    def scope_condition(request):
+        return True
+
+    def __init__(self, get_response: callable):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if self.scope_condition(request):
+            with scope(user=request.user):
+                return self.get_response(request)
+        else:
+            return self.get_response(request)
+
+
+class UserScopeOrDropMiddleware(UserScopeMiddleware):
+    def __call__(self, request):
+        if self.scope_condition(request):
+            if request.user.is_authenticated:
+                with scope(user=request.user):
+                    return self.get_response(request)
+            return HttpResponse('Unauthorized', status=401)
+        return self.get_response(request)

xenua/django/models.py

@@ -0,0 +1,57 @@
+from django.db import models
+from django.utils.crypto import get_random_string
+
+try:
+    from django_scopes import scopes_disabled
+except ImportError:
+    from xenua.decorators import no_op as scopes_disabled
+
+
+class RandomSlugMixin(models.Model):
+    """
+    some alternatives for slug_chars:
+    abcdeghjkpqrsxyz23456789  # 24 chars, max clarity while being all lowercase
+    ABCDGHKLMNQRTabcdeghjr23456789  # 30 chars, max clarity mixed case
+    abcdefghijkmnpqrstuwxyz123467890  # 32 chars, all lowercase
+    """
+    slug_chars = 'abcdefghijkmnpqrstuwxyz123467890'
+
+    class Meta:
+        abstract = True
+
+    slug = models.CharField(max_length=6, unique=True)
+
+    def save(self, **kwargs):
+        self.generate_slug()
+        super().save(**kwargs)
+
+    def generate_slug(self):
+        if not self.slug:
+            self.slug = self.generate_new_slug()
+
+    @scopes_disabled()
+    def generate_new_slug(self):
+        slug = get_random_string(self.slug_length, self.slug_chars)
+        if self.__class__.objects.filter(slug=slug).exists():
+            return self.generate_new_slug()
+        return slug
+
+    @scopes_disabled()
+    @property
+    def slugs_available(self):
+        return self.slug_count_total - self.__class__.objects.count()
+
+    @property
+    def slug_count_total(self):
+        return len(self.slug_chars) ** self.slug_length
+
+    @property
+    def slug_length(self):
+        return self.__class__._meta.get_field('slug').max_length
+
+
+class RandomSlugPKMixin(RandomSlugMixin):
+    slug = models.CharField(max_length=6, unique=True, primary_key=True)
+
+    class Meta:
+        abstract = True

xenua/django/rest/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class RestConfig(AppConfig):
+    name = 'xenua.django.rest'
+    verbose_name = _("xenua rest extensions")

xenua/django/rest/authentication.py

@@ -0,0 +1,6 @@
+from rest_framework.authentication import TokenAuthentication
+from xenua.django.rest.models import Token
+
+
+class TokenAuth(TokenAuthentication):
+    model = Token

xenua/django/rest/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.0.3 on 2022-03-03 10:07
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Token',
+            fields=[
+                ('key', models.CharField(max_length=40, primary_key=True, serialize=False, verbose_name='key')),
+                ('creation_date', models.DateTimeField(auto_now_add=True, verbose_name='Creation Date')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='tokens', to=settings.AUTH_USER_MODEL, verbose_name='User')),
+            ],
+            options={
+                'verbose_name': 'Token',
+                'verbose_name_plural': 'Tokens',
+            },
+        ),
+    ]

xenua/django/rest/models.py

@@ -0,0 +1,35 @@
+import os
+
+from django.conf import settings
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+try:
+    from django_scopes import ScopedManager
+except ImportError:
+    ScopedManager = False
+
+
+class Token(models.Model):
+    key = models.CharField(_('key'), max_length=40, primary_key=True)
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL, related_name='tokens',
+        on_delete=models.CASCADE, verbose_name=_('User'),
+    )
+    creation_date = models.DateTimeField(_('Creation Date'), auto_now_add=True)
+
+    class Meta:
+        verbose_name = _('Token')
+        verbose_name_plural = _('Tokens')
+
+    def save(self, *args, **kwargs):
+        if not self.key:
+            self.key = self.gen_key()
+        return super().save(*args, **kwargs)
+
+    @classmethod
+    def gen_key(cls):
+        return os.urandom(20).hex()
+
+    def __str__(self):
+        return self.key

xenua/django/rest/serializers.py

@@ -0,0 +1,34 @@
+from django.contrib.auth import authenticate
+from rest_framework import serializers
+from xenua.django.rest.views import UserScopedViewMixin
+
+from xenua.django.rest.models import Token
+
+
+class TokenSerializer(UserScopedViewMixin, serializers.ModelSerializer):
+    password = serializers.CharField(style={'input_type': 'password'},
+                                     trim_whitespace=False, write_only=True, required=False)
+
+    class Meta:
+        model = Token
+        fields = ('key', 'creation_date', 'password')
+        read_only_fields = ('key', 'creation_date')
+
+    def validate(self, attrs):
+        username = self.context.get('request').user.username
+        password = attrs.get('password')
+
+        if username and password:
+            user = authenticate(request=self.context['request'],
+                                username=username, password=password)
+
+            if not user:
+                raise serializers.ValidationError('unable to log in', code='authorization')
+
+        else:
+            raise serializers.ValidationError('include username and password for write operations',
+                                              code='authorization')
+        return {'user': user}
+
+    def create(self, validated_data):
+        return self.Meta.model.objects.create(**validated_data)

xenua/django/rest/views.py

@@ -0,0 +1,17 @@
+from rest_framework import viewsets
+from rest_framework.permissions import IsAuthenticated
+from xenua.django.views import UserScopedViewMixin
+
+from xenua.django.rest.models import Token
+
+
+class TokenViewSet(UserScopedViewMixin, viewsets.ModelViewSet):
+    permission_classes = (IsAuthenticated,)
+    queryset = Token.objects.none()  # hack for scope support
+
+    def get_queryset(self):
+        return Token.objects.filter(user=self.request.user)
+
+    def get_serializer_class(self):
+        from xenua.django.rest.serializers import TokenSerializer
+        return TokenSerializer

xenua/django/views.py

@@ -0,0 +1,42 @@
+from functools import wraps
+
+from django.utils.decorators import classonlymethod
+from rest_framework.viewsets import ViewSetMixin
+
+try:
+    from django_scopes import scope
+except ImportError:
+    from xenua.decorators import no_op as scope
+
+try:
+    from rest_framework import APIView
+except ImportError:
+    APIView = None
+
+
+class ScopedViewMixin:
+    def dispatch(self, request, *args, **kwargs):
+        for method_name in self.http_method_names:
+            if (method := getattr(self, method_name, None)) is not None:
+                wrapped_method = wraps(method)(self.apply_scopes(method, method_name))
+                setattr(self, method_name, wrapped_method)
+
+        return super().dispatch(request, *args, **kwargs)
+
+    def apply_scopes(self, to: callable, http_method):
+        def wrapper(request, *args, **kwargs):
+            with scope(**self.get_scopes(request, *args, **kwargs)):
+                return to(request, *args, **kwargs)
+
+        return wrapper
+
+    def get_scopes(self, request, *args, **kwargs):
+        return {}
+
+
+class UserScopedViewMixin(ScopedViewMixin):
+    user_scope_name = 'user'
+
+    def get_scopes(self, r, *args, **kwargs):
+        return {self.user_scope_name: r.user}
+

xenua/secrets.py

@@ -0,0 +1,23 @@
+from os.path import isfile
+from random import SystemRandom
+from string import punctuation, digits, ascii_letters
+
+
+random = SystemRandom()
+
+
+def gen_secret():
+    return ''.join(random.choices(ascii_letters+digits+punctuation, k=64))
+
+
+def load_or_gen_secret(path, secret_func: callable = gen_secret):
+    if isfile(path):
+        with open(path) as f:
+            return f.read()
+    else:
+        from os import chmod
+        with open(path, 'w') as f:
+            secret = secret_func()
+            f.write(secret)
+        chmod(path, 0o400)
+        return secret

xenua/types.py

@@ -0,0 +1,80 @@
+class Vec2:
+    class NotComparable(Exception):
+        ...
+
+    def __init__(self, x, y):
+        self.x = x
+        self.y = y
+
+    def __iter__(self):
+        yield self.x
+        yield self.y
+
+    def __repr__(self):
+        return str(self)
+
+    def __str__(self):
+        return f'Vec2({self.x}, {self.y})'
+
+    def __add__(self, other):
+        x, y = other
+        return Vec2(self.x + x, self.y + y)
+
+    def __sub__(self, other):
+        x, y = other
+        return Vec2(self.x - x, self.y - y)
+
+    def __mul__(self, other):
+        if isinstance(other, int | float):
+            return Vec2(self.x * other, self.y * other)
+        else:
+            return NotImplemented
+
+    def __eq__(self, other):
+        x, y = other
+        return self.x == x and self.y == y
+
+    def __ne__(self, other):
+        x, y = other
+        return self.x != x or self.y != y
+
+    def __gt__(self, other):
+        x, y = other
+        return self.x > x and self.y > y
+
+    def __ge__(self, other):
+        x, y = other
+        return self.x >= x and self.y >= y
+
+    def __lt__(self, other):
+        x, y = other
+        return self.x < x and self.y < y
+
+    def __le__(self, other):
+        x, y = other
+        return self.x <= x and self.y <= y
+
+    def __abs__(self):
+        return Vec2(abs(self.x), abs(self.y))
+
+    def __iadd__(self, other):
+        x, y = other
+        self.x += x
+        self.y += y
+        return self
+
+    def __isub__(self, other):
+        x, y = other
+        self.x -= x
+        self.y -= y
+        return self
+
+    def __imul__(self, other):
+        self.x *= other
+        self.y *= other
+
+    def __complex__(self):
+        return complex(self.x, self.y)
+
+    def __len__(self):
+        return (self.x ** 2 + self.y ** 2) ** 0.5

xenua/utils.py

@@ -0,0 +1,31 @@
+import os
+import sys
+from pathlib import Path
+
+
+class LayeredObject:
+    def __init__(self, *objects):
+        self._objects = objects
+
+    def __getattr__(self, item):
+        for o in self.__dict__['_objects']:
+            try:
+                if isinstance(o, dict):
+                    return o[item]
+                elif isinstance(o, os._Environ):
+                    return o[item.upper()]
+                else:
+                    return getattr(o, item)
+            except (AttributeError, KeyError):
+                pass
+        raise AttributeError(f"None of the objects contained in '{self.__class__.__name__}' have attribute '{item}'.\n"
+                             f"Objects contained: {[repr(o) for o in self.__dict__['_objects']]}")
+
+
+def import_module(path):
+    path = Path(path)
+    assert path.suffix == '.py', f'expected a path to a python module, got {path}'
+    sys.path.insert(1, str(path.parent))
+    mod = __import__(path.stem)
+    sys.path.remove(str(path.parent))
+    return mod