csu 1.0.0__tar.gz

csu-1.0.0/.bumpversion.cfg

@@ -0,0 +1,24 @@
+[bumpversion]
+current_version = 1.0.0
+commit = True
+tag = True
+
+[bumpversion:file:setup.py]
+search = version="{current_version}"
+replace = version="{new_version}"
+
+[bumpversion:file (badge):README.rst]
+search = /v{current_version}.svg
+replace = /v{new_version}.svg
+
+[bumpversion:file (link):README.rst]
+search = /v{current_version}...main
+replace = /v{new_version}...main
+
+[bumpversion:file:src/csu/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
+
+[bumpversion:file:.cookiecutterrc]
+search = version: {current_version}
+replace = version: {new_version}

csu-1.0.0/.cookiecutterrc

@@ -0,0 +1,47 @@
+# Generated by cookiepatcher, a small shim around cookiecutter (pip install cookiepatcher)
+
+default_context:
+    c_extension_optional: 'no'
+    c_extension_support: 'no'
+    codacy: 'yes'
+    codacy_projectid: '[Get ID from https://app.codacy.com/gh/ionelmc/python-csu/settings]'
+    codeclimate: 'no'
+    codecov: 'yes'
+    command_line_interface: 'no'
+    command_line_interface_bin_name: csu
+    coveralls: 'yes'
+    distribution_name: csu
+    email: contact@ionelmc.ro
+    formatter_quote_style: double
+    full_name: Ionel Cristian Mărieș
+    function_name: compute
+    github_actions: 'yes'
+    github_actions_osx: 'no'
+    github_actions_windows: 'no'
+    license: BSD 2-Clause License
+    module_name: core
+    package_name: csu
+    pre_commit: 'yes'
+    project_name: CSU
+    project_short_description: Clean Slate Utils - bunch of utility code, mostly Django/DRF specific.
+    pypi_badge: 'yes'
+    pypi_disable_upload: 'no'
+    release_date: today
+    repo_hosting: github.com
+    repo_hosting_domain: github.com
+    repo_main_branch: main
+    repo_name: python-csu
+    repo_username: ionelmc
+    scrutinizer: 'yes'
+    setup_py_uses_setuptools_scm: 'no'
+    sphinx_docs: 'no'
+    sphinx_docs_hosting: https://python-csu.readthedocs.io/
+    sphinx_doctest: 'no'
+    sphinx_theme: furo
+    test_matrix_separate_coverage: 'no'
+    tests_inside_package: 'yes'
+    version: 1.0.0
+    version_manager: bump2version
+    website: https://blog.ionelmc.ro
+    year_from: '2024'
+    year_to: '2024'

csu-1.0.0/.coveragerc

@@ -0,0 +1,16 @@
+[paths]
+source =
+   src
+   */site-packages
+
+[run]
+branch = true
+source =
+    csu
+    tests
+parallel = true
+
+[report]
+show_missing = true
+precision = 2
+omit = *migrations*

csu-1.0.0/.editorconfig

@@ -0,0 +1,20 @@
+# see https://editorconfig.org/
+root = true
+
+[*]
+# Use Unix-style newlines for most files (except Windows files, see below).
+end_of_line = lf
+trim_trailing_whitespace = true
+indent_style = space
+insert_final_newline = true
+indent_size = 4
+charset = utf-8
+
+[*.{bat,cmd,ps1}]
+end_of_line = crlf
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.tsv]
+indent_style = tab

csu-1.0.0/.github/workflows/github-actions.yml

@@ -0,0 +1,83 @@
+name: build
+on: [push, pull_request, workflow_dispatch]
+jobs:
+  test:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: 'check'
+            python: '3.11'
+            toxpython: 'python3.11'
+            tox_env: 'check'
+            os: 'ubuntu-latest'
+          - name: 'py310-dj4 (ubuntu)'
+            python: '3.10'
+            toxpython: 'python3.10'
+            python_arch: 'x64'
+            tox_env: 'py310-dj4'
+            os: 'ubuntu-latest'
+          - name: 'py310-dj5 (ubuntu)'
+            python: '3.10'
+            toxpython: 'python3.10'
+            python_arch: 'x64'
+            tox_env: 'py310-dj5'
+            os: 'ubuntu-latest'
+          - name: 'py311-dj4 (ubuntu)'
+            python: '3.11'
+            toxpython: 'python3.11'
+            python_arch: 'x64'
+            tox_env: 'py311-dj4'
+            os: 'ubuntu-latest'
+          - name: 'py311-dj5 (ubuntu)'
+            python: '3.11'
+            toxpython: 'python3.11'
+            python_arch: 'x64'
+            tox_env: 'py311-dj5'
+            os: 'ubuntu-latest'
+          - name: 'py312-dj4 (ubuntu)'
+            python: '3.12'
+            toxpython: 'python3.12'
+            python_arch: 'x64'
+            tox_env: 'py312-dj4'
+            os: 'ubuntu-latest'
+          - name: 'py312-dj5 (ubuntu)'
+            python: '3.12'
+            toxpython: 'python3.12'
+            python_arch: 'x64'
+            tox_env: 'py312-dj5'
+            os: 'ubuntu-latest'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python }}
+        architecture: ${{ matrix.python_arch }}
+    - name: install dependencies
+      run: |
+        python -mpip install --progress-bar=off -r ci/requirements.txt
+        virtualenv --version
+        pip --version
+        tox --version
+        pip list --format=freeze
+    - name: test
+      env:
+        TOXPYTHON: '${{ matrix.toxpython }}'
+      run: >
+        tox -e ${{ matrix.tox_env }} -v
+  finish:
+    needs: test
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true
+    - uses: codecov/codecov-action@v3
+      with:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

csu-1.0.0/.gitignore

@@ -0,0 +1,74 @@
+*.py[cod]
+__pycache__
+
+# Temp files
+.*.sw[po]
+*~
+*.bak
+.DS_Store
+
+# C extensions
+*.so
+
+# Build and package files
+*.egg
+*.egg-info
+.bootstrap
+.build
+.cache
+.eggs
+.env
+.installed.cfg
+.ve
+bin
+build
+develop-eggs
+dist
+eggs
+lib
+lib64
+parts
+pip-wheel-metadata/
+pyvenv*/
+sdist
+var
+venv*/
+wheelhouse
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.benchmarks
+.coverage
+.coverage.*
+.pytest
+.pytest_cache/
+.tox
+coverage.xml
+htmlcov
+nosetests.xml
+
+# Translations
+*.mo
+
+# Buildout
+.mr.developer.cfg
+
+# IDE project files
+*.iml
+*.komodoproject
+.idea
+.project
+.pydevproject
+.vscode
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+# Mypy Cache
+.mypy_cache/

csu-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# To install the git pre-commit hooks run:
+#   pre-commit install --install-hooks
+# To update the versions:
+#   pre-commit autoupdate
+exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg)(/|$)'
+# Note the order is intentional to avoid multiple passes of the hooks
+repos:
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.22.1
+    hooks:
+      - id: django-upgrade
+        args: [ --target-version, "4.2" ]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.3
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes]
+      - id: ruff-format
+  - repo: https://github.com/rtts/djhtml
+    rev: 3.0.7
+    hooks:
+      - id: djhtml
+        entry: djhtml --tabwidth 2
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: debug-statements

csu-1.0.0/AUTHORS.rst

@@ -0,0 +1,5 @@
+
+Authors
+=======
+
+* Ionel Cristian Mărieș - https://blog.ionelmc.ro

csu-1.0.0/CHANGELOG.rst

@@ -0,0 +1,8 @@
+
+Changelog
+=========
+
+0.0.0 (2024-03-24)
+------------------
+
+* First release on PyPI.

csu-1.0.0/CONTRIBUTING.rst

@@ -0,0 +1,85 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Bug reports
+===========
+
+When `reporting a bug <https://github.com/ionelmc/python-csu/issues>`_ please include:
+
+    * Your operating system name and version.
+    * Any details about your local setup that might be helpful in troubleshooting.
+    * Detailed steps to reproduce the bug.
+
+Documentation improvements
+==========================
+
+CSU could always use more documentation, whether as part of the
+official CSU docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at https://github.com/ionelmc/python-csu/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
+
+Development
+===========
+
+To set up `python-csu` for local development:
+
+1. Fork `python-csu <https://github.com/ionelmc/python-csu>`_
+   (look for the "Fork" button).
+2. Clone your fork locally::
+
+    git clone git@github.com:YOURGITHUBNAME/python-csu.git
+
+3. Create a branch for local development::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+4. When you're done making changes run all the checks and docs builder with one command::
+
+    tox
+
+5. Commit your changes and push your branch to GitHub::
+
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code just make the pull request.
+
+For merging, you should:
+
+1. Include passing tests (run ``tox``).
+2. Update documentation when there's new API, functionality etc.
+3. Add a note to ``CHANGELOG.rst`` about the changes.
+4. Add yourself to ``AUTHORS.rst``.
+
+Tips
+----
+
+To run a subset of tests::
+
+    tox -e envname -- pytest -k test_myfeature
+
+To run all the test environments in *parallel*::
+
+    tox -p auto

csu-1.0.0/LICENSE

@@ -0,0 +1,10 @@
+BSD 2-Clause License
+
+Copyright (c) 2024, Ionel Cristian Mărieș. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

csu-1.0.0/MANIFEST.in

@@ -0,0 +1,21 @@
+graft docs
+graft src
+graft ci
+graft tests
+
+include .bumpversion.cfg
+include .cookiecutterrc
+include .coveragerc
+include .editorconfig
+include .github/workflows/github-actions.yml
+include .pre-commit-config.yaml
+include pytest.ini
+include tox.ini
+
+include AUTHORS.rst
+include CHANGELOG.rst
+include CONTRIBUTING.rst
+include LICENSE
+include README.rst
+
+global-exclude *.py[cod] __pycache__/* *.so *.dylib

csu-1.0.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.1
+Name: csu
+Version: 1.0.0
+Summary: Clean Slate Utils - bunch of utility code, mostly Django/DRF specific.
+Home-page: https://github.com/ionelmc/python-csu
+Author: Ionel Cristian Mărieș
+Author-email: contact@ionelmc.ro
+License: BSD-2-Clause
+Project-URL: Changelog, https://github.com/ionelmc/python-csu/blob/master/CHANGELOG.rst
+Project-URL: Issue Tracker, https://github.com/ionelmc/python-csu/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: django
+Requires-Dist: djangorestframework
+Requires-Dist: django-crispy-forms
+Requires-Dist: django-import-export
+Requires-Dist: httpx
+Requires-Dist: typing-extensions
+Requires-Dist: defusedxml
+Provides-Extra: phonenumber
+Requires-Dist: phonenumberslite; extra == "phonenumber"
+Requires-Dist: django-phonenumber-field; extra == "phonenumber"
+
+========
+Overview
+========
+
+
+
+Clean Slate Utils - bunch of utility code, mostly Django/DRF specific.
+
+* Free software: BSD 2-Clause License
+
+Installation
+============
+
+::
+
+    pip install csu
+
+You can also install the in-development version with::
+
+    pip install https://github.com/ionelmc/python-csu/archive/main.zip
+
+
+Documentation
+=============
+
+None.
+
+Development
+===========
+
+To run all the tests run::
+
+    tox
+
+Note, to combine the coverage data from all the tox environments run:
+
+.. list-table::
+    :widths: 10 90
+    :stub-columns: 1
+
+    - - Windows
+      - ::
+
+            set PYTEST_ADDOPTS=--cov-append
+            tox
+
+    - - Other
+      - ::
+
+            PYTEST_ADDOPTS=--cov-append tox
+
+
+Changelog
+=========
+
+0.0.0 (2024-03-24)
+------------------
+
+* First release on PyPI.

csu-1.0.0/README.rst

@@ -0,0 +1,101 @@
+========
+Overview
+========
+
+.. start-badges
+
+.. list-table::
+    :stub-columns: 1
+
+    * - tests
+      - |github-actions| |coveralls| |codecov| |scrutinizer| |codacy|
+    * - package
+      - |version| |wheel| |supported-versions| |supported-implementations| |commits-since|
+
+.. |github-actions| image:: https://github.com/ionelmc/python-csu/actions/workflows/github-actions.yml/badge.svg
+    :alt: GitHub Actions Build Status
+    :target: https://github.com/ionelmc/python-csu/actions
+
+.. |coveralls| image:: https://coveralls.io/repos/github/ionelmc/python-csu/badge.svg?branch=main
+    :alt: Coverage Status
+    :target: https://coveralls.io/github/ionelmc/python-csu?branch=main
+
+.. |codecov| image:: https://codecov.io/gh/ionelmc/python-csu/branch/main/graphs/badge.svg?branch=main
+    :alt: Coverage Status
+    :target: https://app.codecov.io/github/ionelmc/python-csu
+
+.. |codacy| image:: https://img.shields.io/codacy/grade/[Get ID from https://app.codacy.com/gh/ionelmc/python-csu/settings].svg
+    :target: https://www.codacy.com/app/ionelmc/python-csu
+    :alt: Codacy Code Quality Status
+
+.. |version| image:: https://img.shields.io/pypi/v/csu.svg
+    :alt: PyPI Package latest release
+    :target: https://pypi.org/project/csu
+
+.. |wheel| image:: https://img.shields.io/pypi/wheel/csu.svg
+    :alt: PyPI Wheel
+    :target: https://pypi.org/project/csu
+
+.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/csu.svg
+    :alt: Supported versions
+    :target: https://pypi.org/project/csu
+
+.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/csu.svg
+    :alt: Supported implementations
+    :target: https://pypi.org/project/csu
+
+.. |commits-since| image:: https://img.shields.io/github/commits-since/ionelmc/python-csu/v1.0.0.svg
+    :alt: Commits since latest release
+    :target: https://github.com/ionelmc/python-csu/compare/v1.0.0...main
+
+.. |scrutinizer| image:: https://img.shields.io/scrutinizer/quality/g/ionelmc/python-csu/main.svg
+    :alt: Scrutinizer Status
+    :target: https://scrutinizer-ci.com/g/ionelmc/python-csu/
+
+
+.. end-badges
+
+Clean Slate Utils - bunch of utility code, mostly Django/DRF specific.
+
+* Free software: BSD 2-Clause License
+
+Installation
+============
+
+::
+
+    pip install csu
+
+You can also install the in-development version with::
+
+    pip install https://github.com/ionelmc/python-csu/archive/main.zip
+
+
+Documentation
+=============
+
+None.
+
+Development
+===========
+
+To run all the tests run::
+
+    tox
+
+Note, to combine the coverage data from all the tox environments run:
+
+.. list-table::
+    :widths: 10 90
+    :stub-columns: 1
+
+    - - Windows
+      - ::
+
+            set PYTEST_ADDOPTS=--cov-append
+            tox
+
+    - - Other
+      - ::
+
+            PYTEST_ADDOPTS=--cov-append tox