pixel-sizes 0.0__tar.gz

pixel_sizes-0.0/.coveragerc

@@ -0,0 +1,4 @@
+[report]
+exclude_lines =
+    @overload
+    pragma: no cover

pixel_sizes-0.0/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[{Makefile,**.mk}]
+indent_style = tab

pixel_sizes-0.0/.github/renovate.json5

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>kitsuyui/renovate-config"
+  ]
+}

pixel_sizes-0.0/.github/workflows/gitignore-in.yml

@@ -0,0 +1,16 @@
+name: Update gitignore file
+
+on:
+  schedule:
+    # daily at 00:00
+    - cron: '0 0 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-gitignore:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: gitignore-in/gh-action@v0.2.2

pixel_sizes-0.0/.github/workflows/happy.yml

@@ -0,0 +1,18 @@
+name: happy-commit
+on:
+  - pull_request
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+
+jobs:
+  happy:
+    runs-on: ubuntu-latest
+    name: happy
+    continue-on-error: true
+    steps:
+      - uses: kitsuyui/happy-commit@v0.9
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pixel_sizes-0.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,49 @@
+name: Packaging
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  release:
+    # "released" events are emitted either when directly be released or be edited from pre-released.
+    types: [prereleased, released]
+
+env:
+  python_version: 3.13
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.python_version }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: |
+          uv python pin ${{ env.python_version }}
+          uv sync
+
+      - name: Build
+        run: uv build
+
+      - name: Publish distribution to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: github.event_name == 'release' && github.event.release.prerelease
+        with:
+          user: __token__
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/
+
+      - name: Publish distribution to PyPI
+        if: github.event_name == 'release' && !github.event.release.prerelease
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

pixel_sizes-0.0/.github/workflows/python-test.yml

@@ -0,0 +1,61 @@
+name: Test
+on:
+  # pull-request events are not triggered when a PR is merged
+  # push events are not triggered when a PR created from a fork repository
+  # So we need both to run tests on every PR and after merging
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.python }}"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint
+        run: uv run poe check
+
+      - name: Check Python version
+        run: |
+          actual_version=$(uv run python --version)
+          expected_version="Python ${{ matrix.python }}"
+          if [ "$actual_version" == *"$expected_version"* ]; then
+            echo "Expected $expected_version, but got $actual_version"
+            exit 1
+          fi
+      - name: Test
+        run: uv run poe test
+
+      - name: Coverage
+        run: uv run poe coverage-xml
+
+      - name: Upload coverage report to Codecov
+        if: matrix.python == '3.13'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: true
+          verbose: true

pixel_sizes-0.0/.github/workflows/spellcheck.yml

@@ -0,0 +1,16 @@
+name: Spellcheck
+on:
+  - pull_request
+permissions:
+  contents: read
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check spelling
+        uses: crate-ci/typos@master
+        # typos is a Source code spell checker
+        # https://github.com/crate-ci/typos

pixel_sizes-0.0/.gitignore

@@ -0,0 +1,249 @@
+# DO NOT EDIT THIS FILE
+# Generated by gitignore.in
+# Edit .gitignore.in instead of this file
+# Run `gitignore.in` to build .gitignore
+# -----------------------------------------------------------------------------
+# gibo dump Linux
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Linux.gitignore
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+# -----------------------------------------------------------------------------
+# gibo dump Windows
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Windows.gitignore
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+# -----------------------------------------------------------------------------
+# gibo dump macOS
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/macOS.gitignore
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+# -----------------------------------------------------------------------------
+# gibo dump Python
+### Generated by gibo (https://github.com/simonwhitaker/gibo)
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+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
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# 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/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+# -----------------------------------------------------------------------------
+_version.py

pixel_sizes-0.0/.gitignore.in

@@ -0,0 +1,5 @@
+gibo dump Linux
+gibo dump Windows
+gibo dump macOS
+gibo dump Python
+echo '_version.py'

pixel_sizes-0.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2022-2025 Kitsu Yui
+
+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.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+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.

pixel_sizes-0.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: pixel_sizes
+Version: 0.0
+Summary: Pixel sizes
+Author-email: Yui KITSU <kitsuyui+github@kitsuyui.com>
+License: Copyright 2022-2025 Kitsu Yui
+        
+        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.
+        
+        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/kitsuyui/python-pixel-sizes
+Classifier: License :: OSI Approved :: BSD License
+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 :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# python-pixel-sizes
+
+[![codecov](https://codecov.io/gh/kitsuyui/python-pixel-sizes/graph/badge.svg?token=830WMASKHU)](https://codecov.io/gh/kitsuyui/python-pixel-sizes)
+
+## Usage
+
+```python
+from pixel_sizes import SIZES
+
+SIZES['Full HD'].width  # 1920
+SIZES['Full HD'].height  # 1080
+SIZES['Full HD'].aspect_ratio()  # 16/9 == 1.7777777777777777
+SIZES['Full HD'].aspect_ratio_two()  # (16, 9)
+```
+
+# LICENSE
+
+The 3-Clause BSD License. See also LICENSE file.

pixel_sizes-0.0/README.md

@@ -0,0 +1,18 @@
+# python-pixel-sizes
+
+[![codecov](https://codecov.io/gh/kitsuyui/python-pixel-sizes/graph/badge.svg?token=830WMASKHU)](https://codecov.io/gh/kitsuyui/python-pixel-sizes)
+
+## Usage
+
+```python
+from pixel_sizes import SIZES
+
+SIZES['Full HD'].width  # 1920
+SIZES['Full HD'].height  # 1080
+SIZES['Full HD'].aspect_ratio()  # 16/9 == 1.7777777777777777
+SIZES['Full HD'].aspect_ratio_two()  # (16, 9)
+```
+
+# LICENSE
+
+The 3-Clause BSD License. See also LICENSE file.

pixel_sizes-0.0/pixel_sizes/__init__.py

@@ -0,0 +1,101 @@
+from dataclasses import dataclass
+import math
+
+# https://packaging-guide.openastronomy.org/en/latest/advanced/versioning.html
+from ._version import __version__
+
+
+@dataclass(frozen=True)
+class Size:
+    """A class to represent a size in pixels.
+    Attributes:
+        width (int): The width of the size in pixels.
+        height (int): The height of the size in pixels.
+    """
+
+    width: int
+    height: int
+
+    def aspect_ratio(self) -> float:
+        """Returns the aspect ratio as a float.
+        Example: 1920x1080 => 16/9 => 1.7777777777777777
+        """
+        return self.width / self.height
+
+    def aspect_ratio_two(self) -> tuple[int, int]:
+        """Returns the aspect ratio as a tuple of integers.
+        Example: 1920x1080 => (16, 9)
+        """
+        gcd = math.gcd(self.width, self.height)
+        return self.width // gcd, self.height // gcd
+
+    def rotate(self) -> "Size":
+        """Returns a new Size object with the width and height swapped.
+        Example: 1920x1080 => 1080x1920
+        """
+        return Size(self.height, self.width)
+
+    def scale(self, factor: int) -> "Size":
+        """Returns a new Size object with the width and height scaled by the given factor.
+        Example: 1920x1080, factor=2 => 3840x2160
+        """
+        return Size(self.width * factor, self.height * factor)
+
+
+SIZES = {
+    "480p": Size(854, 480),
+    "360p": Size(640, 360),
+    "240p": Size(426, 240),
+    "144p": Size(256, 144),
+    "720p": Size(1280, 720),
+    "Full HD": Size(1920, 1080),
+    "HD 1080p": Size(1920, 1080),
+    "1080p": Size(1920, 1080),
+    "1080i": Size(1920, 1080),
+    "HD": Size(1280, 720),
+    "QCIF": Size(176, 144),
+    "QVGA": Size(320, 240),
+    "HVGA": Size(480, 320),
+    "DCGA": Size(640, 400),
+    "VGA": Size(640, 480),
+    "SVGA": Size(800, 600),
+    "WSVGA": Size(1024, 600),  # 2 versions
+    "DoubleVGA": Size(960, 640),
+    "XGA": Size(1024, 768),
+    "HD 720p": Size(1280, 720),
+    "WXGA": Size(1280, 800),
+    "FWXGA": Size(1366, 768),
+    "WXGA+": Size(1440, 900),
+    "HD+": Size(1600, 900),
+    "WXGA++": Size(1600, 900),
+    "SXGA+": Size(1400, 1050),
+    "WSXGA+": Size(1680, 1050),
+    "UXGA": Size(1600, 1200),
+    "WQHD": Size(2560, 1440),
+    # https://en.wikipedia.org/wiki/2K_resolution
+    "DCI 2K": Size(2048, 1080),
+    "DCI 2K (flat cropped)": Size(1998, 1080),
+    "DCI 2K (CinemaScope cropped)": Size(2048, 858),
+    "QXGA": Size(2048, 1536),
+    "WQXGA": Size(2560, 1600),
+    "WUXGA": Size(1920, 1200),
+    "QWXGA": Size(2048, 1152),
+    "QUXGA": Size(3200, 2400),
+    "QUXGA Wide": Size(3840, 2400),
+    # https://en.wikipedia.org/wiki/4K_resolution
+    "DCI 4K": Size(4096, 2160),
+    "DCI 4K (flat cropped)": Size(3996, 2160),
+    "DCI 4K (CinemaScope cropped)": Size(4096, 1716),
+    "4K UHD": Size(3840, 2160),
+    "4K UHDTV": Size(3840, 2160),
+    "UHDTV1": Size(3840, 2160),
+    "2160p": Size(3840, 2160),
+    # https://en.wikipedia.org/wiki/5K_resolution
+    "5K": Size(5120, 2880),
+    "5K2K": Size(5120, 2160),
+    # https://en.wikipedia.org/wiki/8K_resolution
+    "8K UHD": Size(7680, 4320),
+    "UHDTV2": Size(7680, 4320),
+}
+
+__all__ = ["Size", "SIZES", "__version__"]

pixel_sizes-0.0/pixel_sizes/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0'
+__version_tuple__ = version_tuple = (0, 0)