codesorter 0.1.0__tar.gz

codesorter-0.1.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    labels:
+      - "Dependencies"
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: monthly
+    labels:
+      - "Dependencies"

codesorter-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+concurrency:
+  group: check-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  ci:
+    name: CI
+    uses: praw-dev/.github/.github/workflows/ci.yml@9ff8957d0cab4cf8c9d7cb5592aedb3d456cc058 # v1.4.0
+    with:
+      min_python: "3.10"
+      python_versions: '["3.10", "3.11", "3.12", "3.13", "3.14"]'
+name: CI
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+permissions: read-all

codesorter-0.1.0/.github/workflows/pre-commit_autoupdate.yml

@@ -0,0 +1,14 @@
+jobs:
+  pre-commit_autoupdate:
+    name: Update pre-commit hooks
+    secrets:
+      APP_ID: ${{ secrets.APP_ID }}
+      APP_PRIVATE_KEY: ${{ secrets.APP_PRIVATE_KEY }}
+    uses: praw-dev/.github/.github/workflows/pre-commit_autoupdate.yml@9ff8957d0cab4cf8c9d7cb5592aedb3d456cc058 # v1.4.0
+name: Update pre-commit hooks
+on:
+  schedule:
+    - cron: 0 15 * * 1
+  workflow_dispatch:
+permissions:
+  contents: read

codesorter-0.1.0/.github/workflows/prepare_release.yml

@@ -0,0 +1,20 @@
+name: Prepare Release
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: The version to prepare for release
+        required: true
+permissions:
+  contents: read
+jobs:
+  prepare_release:
+    name: Prepare Release
+    secrets:
+      APP_ID: ${{ secrets.APP_ID }}
+      APP_PRIVATE_KEY: ${{ secrets.APP_PRIVATE_KEY }}
+    uses: praw-dev/.github/.github/workflows/prepare_release.yml@9ff8957d0cab4cf8c9d7cb5592aedb3d456cc058 # v1.4.0
+    with:
+      package: codesorter
+      version: ${{ inputs.version }}
+      version_file: const.py

codesorter-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,29 @@
+jobs:
+  pypi-publish:
+    environment: release
+    name: Upload release to PyPI
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: 3.x
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+permissions:
+  contents: read

codesorter-0.1.0/.github/workflows/scorecard.yml

@@ -0,0 +1,40 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  branch_protection_rule:
+  schedule:
+    - cron: '36 1 * * 3'
+  push:
+    branches: ["main"]
+permissions: read-all
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      id-token: write
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          persist-credentials: false
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2
+        with:
+          sarif_file: results.sarif

codesorter-0.1.0/.github/workflows/stale_action.yml

@@ -0,0 +1,12 @@
+jobs:
+  stale_action:
+    name: Close stale issues and PRs
+    uses: praw-dev/.github/.github/workflows/stale_action.yml@9ff8957d0cab4cf8c9d7cb5592aedb3d456cc058 # v1.4.0
+name: Close stale issues and PRs
+on:
+  schedule:
+    - cron: 0 */6 * * *
+  workflow_dispatch:
+permissions:
+  issues: write
+  pull-requests: write

codesorter-0.1.0/.github/workflows/tag_release.yml

@@ -0,0 +1,10 @@
+name: Tag Release
+on:
+  push:
+    branches: [main]
+permissions:
+  contents: write
+jobs:
+  tag_release:
+    name: Tag Release
+    uses: praw-dev/.github/.github/workflows/tag_release.yml@9ff8957d0cab4cf8c9d7cb5592aedb3d456cc058 # v1.4.0

codesorter-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Byte-compiled / cached
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Virtual envs
+.venv/
+venv/
+env/
+
+# Test / coverage
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.pytest_cache/
+.tox/
+
+# Docs
+docs/_build/
+
+# Type / lint caches
+.ruff_cache/
+.mypy_cache/
+.pyright/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/
+
+# Project-local runtime artifacts
+sorted.json

codesorter-0.1.0/.libcst.codemod.yaml

@@ -0,0 +1,36 @@
+# String that LibCST should look for in code which indicates that the
+# module is generated code.
+generated_code_marker: '@generated'
+# Command line and arguments for invoking a code formatter. Anything
+# specified here must be capable of taking code via stdin and returning
+# formatted code via stdout.
+formatter: ['ruff', 'format', '-']
+# List of regex patterns which LibCST will evaluate against filenames to
+# determine if the module should be touched.
+blacklist_patterns:
+- '.*/\.bzr/.*'
+- '.*/\.direnv/.*'
+- '.*/\.eggs/.*'
+- '.*/\.git/.*'
+- '.*/\.hg/.*'
+- '.*/\.mypy_cache/.*'
+- '.*/\.nox/.*'
+- '.*/\.pytest_cache/.*'
+- '.*/\.ruff_cache/.*'
+- '.*/\.svn/.*'
+- '.*/\.tox/.*'
+- '.*/\.venv/.*'
+- '.*/__pycache__/.*'
+- '.*/__pypackages__/.*'
+- '.*/build/.*'
+- '.*/dist/.*'
+- '.*/env/.*'
+- '.*/node_modules/.*'
+- '.*/venv/.*'
+# List of modules that contain codemods inside of them.
+modules:
+- 'codesorter'
+# Absolute or relative path of the repository root, used for providing
+# full-repo metadata. Relative paths should be specified with this file
+# location as the base.
+repo_root: '.'

codesorter-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+repos:
+  - repo: local
+    hooks:
+      - always_run: true
+        entry: codesorter --exclude examples --exclude test_files
+        id: codesorter
+        language: system
+        name: codesorter
+        pass_filenames: false
+        types: [ python ]
+
+  - hooks:
+      - id: docstrfmt
+        require_serial: true
+    repo: https://github.com/LilSpazJoekp/docstrfmt
+    rev: 8688ba6420d7b5ca95a8ba0edf8a9953babdc3da  # frozen: v2.1.1
+
+  - hooks:
+      - id: auto-walrus
+    repo: https://github.com/MarcoGorelli/auto-walrus
+    rev: 1743edbed52f3d61886b59d98a27164a8af29c0d  # frozen: 0.4.1
+
+  - hooks:
+      - args: [ --exit-non-zero-on-fix, --fix ]
+        id: ruff
+      - id: ruff-format
+    repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 3b3f7c3f57fe9925356faf5fe6230835138be230  # frozen: v0.15.17
+
+  - hooks:
+      - files: ^(.*\.toml)$
+        id: toml-sort-fix
+    repo: https://github.com/pappasam/toml-sort
+    rev: 2970ae9bb7124fe5117a27e10c10d2da051ce05a  # frozen: v0.24.4
+
+  - hooks:
+      - id: check-added-large-files
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - args: [ --fix=lf ]
+        id: mixed-line-ending
+      - args: [ --pytest-test-first ]
+        files: ^tests/(integration|unit)/.*\.py$
+        id: name-tests-test
+      - id: no-commit-to-branch
+      - files: ^(\.github/workflows/.*\.ya?ml|\.readthedocs.ya?ml)$
+        id: sort-simple-yaml
+      - id: trailing-whitespace
+    repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c  # frozen: v6.0.0

codesorter-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,15 @@
+- id: codesorter
+  name: codesorter
+  description: Sort Python code with codesorter.
+  entry: codesorter
+  language: python
+  types: [python]
+  require_serial: true
+
+- id: codesorter-check
+  name: codesorter (check)
+  description: Check that Python code is sorted by codesorter.
+  entry: codesorter --check
+  language: python
+  types: [python]
+  require_serial: true

codesorter-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

codesorter-0.1.0/.readthedocs.yaml

@@ -0,0 +1,14 @@
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.14"
+  jobs:
+    install:
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --no-dev --group docs --link-mode=copy
+formats:
+  - htmlzip
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+version: 2

codesorter-0.1.0/CHANGES.rst

@@ -0,0 +1,19 @@
+############
+ Change Log
+############
+
+codesorter follows `semantic versioning <https://semver.org/>`_.
+
+********************
+ 0.1.0 (2026/06/14)
+********************
+
+**Added**
+
+- Initial release of CodeSorter.
+- CLI interface with directory walking, sensible default excludes, ``.gitignore``
+  honoring, and ``-e/--exclude`` / ``--no-default-excludes`` / ``--no-gitignore`` flags.
+- Pre-commit hooks (``codesorter`` and ``codesorter-check``) for downstream consumers.
+- Comprehensive test suite covering function, method, property, fixture, decorator, and
+  inheritance sort behaviors.
+- Example before/after files in ``examples/``.

codesorter-0.1.0/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2022, Joel Payne
+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.

codesorter-0.1.0/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.4
+Name: codesorter
+Version: 0.1.0
+Summary: A Python codemod that sorts and organizes code in your files.
+Project-URL: Change Log, https://codesorter.readthedocs.io/en/latest/package_info/change_log.html
+Project-URL: Documentation, https://codesorter.readthedocs.io/
+Project-URL: Issue Tracker, https://github.com/praw-dev/CodeSorter/issues
+Project-URL: Source Code, https://github.com/praw-dev/CodeSorter
+Author-email: Joel Payne <lilspazjoekp@gmail.com>
+Maintainer-email: Joel Payne <lilspazjoekp@gmail.com>, Bryce Boe <bbzbryce@gmail.com>
+License: Copyright (c) 2022, Joel Payne
+        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.
+License-File: LICENSE.txt
+Keywords: codemod,codesorter,libcst,sort
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: libcst<2.0.0,>=1.8.6
+Requires-Dist: pathspec>=1.1.1
+Description-Content-Type: text/x-rst
+
+############
+ CodeSorter
+############
+
+CodeSorter is a LibCST codemod that automatically sorts and organizes Python code.
+
+**********
+ Features
+**********
+
+- **Smart Sorting**: Automatically sorts functions, classes, and methods alphabetically
+- **Decorator Awareness**: Properly handles ``@property``, ``@staticmethod``,
+  ``@classmethod``, and ``@pytest.fixture`` decorators
+- **Hierarchical Organization**: Maintains logical grouping within classes and modules
+- **Pytest Integration**: Special handling for pytest fixtures with proper scope
+  ordering
+- **CLI Interface**: Simple command-line interface for easy integration
+- **Pre-commit Hook**: Ready-to-use pre-commit hook for automated code organization
+
+**************
+ Installation
+**************
+
+From PyPI:
+
+.. code-block:: bash
+
+    # using uv and add to the lint dependency group
+    uv add --group lint codesorter
+    # or using pip
+    pip install codesorter
+
+From Source:
+
+.. code-block:: bash
+
+    git clone https://github.com/praw-dev/CodeSorter.git
+    cd CodeSorter
+    uv pip install -e .
+
+Development Installation:
+
+.. code-block:: bash
+
+    git clone https://github.com/praw-dev/CodeSorter.git
+    cd CodeSorter
+    uv sync
+
+*******
+ Usage
+*******
+
+Command Line Interface
+======================
+
+The simplest way to use CodeSorter is through the command-line interface:
+
+.. code-block:: bash
+
+    # Sort a single file
+    codesorter my_file.py
+
+    # Sort all Python files in a directory
+    codesorter my_project/
+
+    # Sort with additional options
+    codesorter --help
+
+Pre-commit Hook
+===============
+
+Add CodeSorter to your pre-commit configuration to automatically sort code on every
+commit:
+
+.. code-block:: yaml
+
+    # .pre-commit-config.yaml
+    repos:
+      - repo: https://github.com/praw-dev/CodeSorter
+        rev: v0.0.3
+        hooks:
+          - id: codesorter
+
+Or use the check-only variant, which fails the hook without modifying files:
+
+.. code-block:: yaml
+
+    repos:
+      - repo: https://github.com/praw-dev/CodeSorter
+        rev: v0.0.3
+        hooks:
+          - id: codesorter-check
+
+Programmatic Usage
+==================
+
+You can also use CodeSorter programmatically:
+
+.. code-block:: python
+
+    import libcst as cst
+    from codesorter.sort_code import SortCodeCommand
+    from libcst.codemod import CodemodContext
+
+    # Parse your code
+    code = """
+    def z_function():
+        pass
+
+    def a_function():
+        pass
+    """
+
+    # Create context and command
+    context = CodemodContext()
+    command = SortCodeCommand(context)
+
+    # Transform the code
+    result = command.transform_module(cst.parse_module(code))
+    print(result.code)
+
+**************
+ How It Works
+**************
+
+CodeSorter uses LibCST (Concrete Syntax Tree) to parse and transform Python code. It
+applies sophisticated sorting rules:
+
+Function Sorting
+================
+
+- Functions are sorted alphabetically by name
+- Global functions are sorted separately from class methods
+
+Class Method Sorting
+====================
+
+- Methods are sorted with special consideration for decorators: - ``@property`` methods
+  (getters, setters, deleters) - ``@staticmethod`` methods - ``@classmethod`` methods -
+  Regular instance methods
+- Methods within classes maintain their logical grouping
+
+Pytest Fixture Sorting
+======================
+
+- Fixtures are sorted by scope (session, package, module, class, function)
+- Within each scope, fixtures are sorted alphabetically
+- ``autouse`` fixtures are handled specially
+
+Example Transformation
+======================
+
+**Before:**
+
+.. code-block:: python
+
+    class MyClass:
+        def z_method(self):
+            pass
+
+        @property
+        def a_property(self):
+            pass
+
+        @staticmethod
+        def b_static():
+            pass
+
+**After:**
+
+.. code-block:: python
+
+    class MyClass:
+        @property
+        def a_property(self):
+            pass
+
+        @staticmethod
+        def b_static():
+            pass
+
+        def z_method(self):
+            pass
+
+*************
+ Development
+*************
+
+Setting Up Development Environment
+==================================
+
+.. code-block:: bash
+
+    # Clone the repository
+    git clone https://github.com/praw-dev/CodeSorter.git
+    cd CodeSorter
+
+    # Install with development dependencies
+    uv sync
+
+    # Install pre-commit hooks
+    uv run pre-commit install
+
+Running Tests
+=============
+
+.. code-block:: bash
+
+    # Run all tests
+    uv run pytest
+
+    # Run a specific test file
+    uv run pytest tests/test_sort_code.py
+
+    # Run the full tox matrix (tests, type, pre-commit)
+    uv run tox
+
+Code Quality
+============
+
+The project uses several tools to maintain code quality:
+
+- **Ruff**: Fast linting and formatting
+- **Pyright**: Type checking
+- **Pre-commit**: Automated quality checks
+
+Run all quality checks:
+
+.. code-block:: bash
+
+    uv run pre-commit run --all-files
+
+**************
+ Contributing
+**************
+
+1. Fork the repository
+2. Create a feature branch: ``git checkout -b feature-name``
+3. Make your changes and add tests
+4. Run the test suite: ``uv run pytest``
+5. Run pre-commit hooks: ``pre-commit run --all-files``
+6. Commit your changes: ``git commit -m "Add feature"``
+7. Push to your fork: ``git push origin feature-name``
+8. Create a Pull Request
+
+**********
+ Examples
+**********
+
+See the ``examples/`` directory for before and after examples of CodeSorter in action:
+
+- ``examples/before_example.py``: Unsorted code
+- ``examples/after_example.py``: Same code after sorting
+
+*********
+ License
+*********
+
+This project is licensed under the MIT License - see the `LICENSE.txt
+<https://github.com/praw-dev/CodeSorter/blob/main/LICENSE.txt>`_ file for details.
+
+***********
+ Changelog
+***********
+
+See the `change log
+<https://codesorter.readthedocs.io/en/latest/package_info/change_log.html>`_ for the
+full list of changes.