docstringify 0.1.0__tar.gz

docstringify-0.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# Dependabot version updates. See docs for configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every month
+      interval: "monthly"

docstringify-0.1.0/.github/release.yml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci

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

@@ -0,0 +1,64 @@
+# This workflow builds docstringify on Mac, Linux, and Windows for
+# multiple versions of Python to confirm it can be properly installed.
+#
+# Based on https://github.com/stefmolin/data-morph/blob/main/.github/workflows/ci.yml
+#
+# Author: Stefanie Molin
+
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+    paths:
+      - '**'
+      - '!.github/**'
+      - '.github/workflows/ci.yml'
+    tags: [ "v*" ]
+
+  pull_request:
+    paths:
+      - '**'
+      - '!.github/**'
+      - '.github/workflows/ci.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build with Python ${{ matrix.python-version }} on ${{ matrix.os }}
+
+    # The type of runner that the job will run on
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -e {0}
+
+    strategy:
+        fail-fast: false
+        matrix:
+            os: [macos-latest, ubuntu-latest, windows-latest]
+            python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55  # v5.5.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install docstringify
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools --upgrade
+          python -m pip install .
+
+      - name: Check entry point
+        run: docstringify --version
+
+      - name: Install testing dependencies
+        run: python -m pip install '.[dev]'

docstringify-0.1.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,120 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    tags: ["*"]
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+    - name: Set up Python
+      uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55  # v5.5.0
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4.6.2
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/') && !contains(github.ref, '-rc')  # only publish releases to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/docstringify
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e  # v4.2.1
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e  # v4.2.1
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@f514d46b907ebcd5bedc05145c03b69c1edd8b46  # v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --generate-notes
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    if: startsWith(github.ref, 'refs/tags/') && contains(github.ref, '-rc') # only publish release candidates to TestPyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/docstringify
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e  # v4.2.1
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4
+      with:
+        repository-url: https://test.pypi.org/legacy/

docstringify-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

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

@@ -0,0 +1,25 @@
+ci:
+  autofix_prs: false
+  autoupdate_schedule: quarterly
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes]
+      - id: ruff-format
+
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: v2.5.1
+    hooks:
+      - id: pyproject-fmt
+        args: [--keep-full-version, --no-print-diff]

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

@@ -0,0 +1,8 @@
+- id: docstringify
+  name: docstringify
+  description: |
+    Flag missing docstrings and, optionally, generate them from signatures and type annotations.
+  entry: docstringify
+  language: python
+  serial: true
+  types: [python]

docstringify-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Stefanie Molin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docstringify-0.1.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: docstringify
+Version: 0.1.0
+Summary: Flag missing docstrings and, optionally, generate them from signatures and type annotations.
+Author-email: Stefanie Molin <docstringify@stefaniemolin.com>
+License: MIT License
+        
+        Copyright (c) 2025 Stefanie Molin
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Documentation, https://github.com/stefmolin/docstringify
+Project-URL: Homepage, https://github.com/stefmolin/docstringify
+Project-URL: Source, https://github.com/stefmolin/docstringify
+Keywords: ast,docstring generation,numpydoc-style docstring,pre-commit
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+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 :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-randomly; extra == "dev"
+Dynamic: license-file
+
+# docstringify
+Flag missing docstrings and, optionally, generate them from signatures and type annotations.
+
+## Usage
+
+### Pre-commit hook
+
+Add the following to your `.pre-commit-config.yaml` file to block commits with missing docstrings:
+
+```yaml
+- repo: https://github.com/stefmolin/docstringify
+  rev: 0.1.0
+  hooks:
+    - id: docstringify
+```
+
+By default, all docstrings are required. If you want to be more lenient, you can set the threshold, which is the percentage of docstrings that must be present:
+
+```yaml
+- repo: https://github.com/stefmolin/docstringify
+  rev: 0.1.0
+  hooks:
+    - id: docstringify
+      args: [--threshold=0.75]
+```
+
+If you would like to see suggested docstring templates (inferred from type annotations for functions and methods), provide the `--suggest-changes` argument. By default, these will be [numpydoc-style docstrings](https://numpydoc.readthedocs.io/en/latest/format.html#); support for Google-style docstrings will come in a future release:
+
+```yaml
+- repo: https://github.com/stefmolin/docstringify
+  rev: 0.1.0
+  hooks:
+    - id: docstringify
+      args: [--suggest-changes]
+```
+
+Be sure to check out the [pre-commit documentation](https://pre-commit.com/#pre-commit-configyaml---hooks) for additional configuration options.
+
+### Command line
+
+First, install the `docstringify` package from PyPI:
+
+```shell
+$ python -m pip install docstringify
+```
+
+Then, use the `docstringify` entry point on the file(s) of your choice:
+
+```shell
+$ docstringify /path/to/file [/path/to/another/file]
+```
+
+Run `docstringify --help` for more information.
+
+### Python
+
+First, install the `docstringify` package from PyPI:
+
+```shell
+$ python -m pip install docstringify
+```
+
+Then, use the `DocstringVisitor()` class on individual files to see spots where docstrings are missing:
+
+```pycon
+>>> from docstringify.visitor import DocstringVisitor
+>>> visitor = DocstringVisitor('test.py')
+>>> visitor.process_file()
+test is missing a docstring
+test.say_hello is missing a docstring
+```
+
+If you would like to see suggested docstring templates (inferred from type annotations for functions and methods), provide a converter:
+
+```pycon
+>>> from docstringify.converters.numpydoc import NumpydocDocstringConverter
+>>> from docstringify.visitor import DocstringVisitor
+>>> visitor = DocstringVisitor('test.py', converter=NumpydocDocstringConverter())
+>>> visitor.process_file()
+test is missing a docstring
+Hint:
+"""__description__"""
+
+test.say_hello is missing a docstring
+Hint:
+"""
+__description__
+
+Parameters
+----------
+name : str, default="World"
+    __description__
+"""
+
+```

docstringify-0.1.0/README.md

@@ -0,0 +1,95 @@
+# docstringify
+Flag missing docstrings and, optionally, generate them from signatures and type annotations.
+
+## Usage
+
+### Pre-commit hook
+
+Add the following to your `.pre-commit-config.yaml` file to block commits with missing docstrings:
+
+```yaml
+- repo: https://github.com/stefmolin/docstringify
+  rev: 0.1.0
+  hooks:
+    - id: docstringify
+```
+
+By default, all docstrings are required. If you want to be more lenient, you can set the threshold, which is the percentage of docstrings that must be present:
+
+```yaml
+- repo: https://github.com/stefmolin/docstringify
+  rev: 0.1.0
+  hooks:
+    - id: docstringify
+      args: [--threshold=0.75]
+```
+
+If you would like to see suggested docstring templates (inferred from type annotations for functions and methods), provide the `--suggest-changes` argument. By default, these will be [numpydoc-style docstrings](https://numpydoc.readthedocs.io/en/latest/format.html#); support for Google-style docstrings will come in a future release:
+
+```yaml
+- repo: https://github.com/stefmolin/docstringify
+  rev: 0.1.0
+  hooks:
+    - id: docstringify
+      args: [--suggest-changes]
+```
+
+Be sure to check out the [pre-commit documentation](https://pre-commit.com/#pre-commit-configyaml---hooks) for additional configuration options.
+
+### Command line
+
+First, install the `docstringify` package from PyPI:
+
+```shell
+$ python -m pip install docstringify
+```
+
+Then, use the `docstringify` entry point on the file(s) of your choice:
+
+```shell
+$ docstringify /path/to/file [/path/to/another/file]
+```
+
+Run `docstringify --help` for more information.
+
+### Python
+
+First, install the `docstringify` package from PyPI:
+
+```shell
+$ python -m pip install docstringify
+```
+
+Then, use the `DocstringVisitor()` class on individual files to see spots where docstrings are missing:
+
+```pycon
+>>> from docstringify.visitor import DocstringVisitor
+>>> visitor = DocstringVisitor('test.py')
+>>> visitor.process_file()
+test is missing a docstring
+test.say_hello is missing a docstring
+```
+
+If you would like to see suggested docstring templates (inferred from type annotations for functions and methods), provide a converter:
+
+```pycon
+>>> from docstringify.converters.numpydoc import NumpydocDocstringConverter
+>>> from docstringify.visitor import DocstringVisitor
+>>> visitor = DocstringVisitor('test.py', converter=NumpydocDocstringConverter())
+>>> visitor.process_file()
+test is missing a docstring
+Hint:
+"""__description__"""
+
+test.say_hello is missing a docstring
+Hint:
+"""
+__description__
+
+Parameters
+----------
+name : str, default="World"
+    __description__
+"""
+
+```