sphinx-source-tree 0.1__tar.gz

sphinx_source_tree-0.1/.coveralls.yml

@@ -0,0 +1 @@
+service_name: github-actions

sphinx_source_tree-0.1/.env

@@ -0,0 +1,2 @@
+GITHUB_TOKEN
+COVERALLS_REPO_TOKEN

sphinx_source_tree-0.1/.github/workflows/test.yml

@@ -0,0 +1,106 @@
+name: test
+
+on:
+  push:
+  pull_request:
+    types: [review_requested, ready_for_review]
+
+jobs:
+  # *************************************
+  # ************* Pre-commit ************
+  # *************************************
+  pre-commit:
+    name: pre-commit ${{ matrix.python-version }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      max-parallel: 5
+      matrix:
+        os:
+          - ubuntu-22.04
+        python-version:
+          - "3.11"
+#          - "3.10"
+#          - "3.9"
+#          - "3.8"
+#          - "3.7"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install detect-secrets
+        run: pip install --no-cache-dir detect-secrets doc8 isort
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1
+
+  # *************************************
+  # **************** Tests **************
+  # *************************************
+  test:
+    needs: pre-commit
+    name: test ${{ matrix.python-version }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      max-parallel: 5
+      matrix:
+        os:
+          - ubuntu-22.04
+        #          - Windows
+        #          - MacOs
+        python-version:
+          - "3.13"
+          - "3.12"
+          - "3.11"
+          - "3.10"
+#          - "3.9"
+    steps:
+      - name: Clean-up
+        run: sudo apt clean && sudo apt autoclean && sudo rm -rf /tmp/* && sudo rm -rf /usr/share/dotnet && sudo rm -rf /opt/ghc && sudo rm -rf "/usr/local/share/boost" && sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+      - name: Install package
+        run: |
+          pip install -e .[all]
+      - name: Run test suite
+        run: pytest -vrx
+        env:
+          PYTEST_ADDOPTS: "-vv --durations=10"
+      - name: Coveralls
+        id: coveralls-setup
+        continue-on-error: true
+        uses: AndreMiras/coveralls-python-action@develop
+        with:
+          parallel: true
+          flag-name: Run Tests
+
+  # *************************************
+  # ************** Coveralls ************
+  # *************************************
+  coveralls_finish:
+    name: coveralls_finish
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install dependencies
+      run: |
+        python -m pip install pyyaml
+    - name: Coveralls Finished
+      id: coveralls-finish
+      continue-on-error: true
+#      if: steps.coveralls-setup.outcome == 'success'
+      env:
+        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      uses: AndreMiras/coveralls-python-action@develop
+      with:
+        parallel-finished: true
+        debug: true

sphinx_source_tree-0.1/.gitignore

@@ -0,0 +1,38 @@
+*.py[cod]
+.gitignore~
+.tox/
+.cache/
+.coverage*
+!.coveragerc
+/htmlcov/
+*.py,cover
+.idea/
+.vscode/
+.pytest_cache/
+/coverage.xml
+.eggs/
+
+codebin/
+/tmp/
+.zip
+/examples/db/
+/var/
+/examples/tmp/
+/examples/logs/
+/builddocs/
+/builddocs.zip
+/build/
+/dist/
+sphinx_source_tree.egg-info/
+matyan.log*
+db.sqlite3
+sample_db.sqlite
+test_database.db
+local_settings.py
+/prof/
+*.cast
+.ipynb_checkpoints/
+.scannerwork/
+*db.sqlite3*
+.mypy_cache/
+uv.lock

sphinx_source_tree-0.1/.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+exclude: "^docs/|/migrations/"
+default_stages: [ pre-commit, pre-push ]
+default_language_version:
+  python: python3
+
+repos:
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: v2.0.0
+    hooks:
+      - id: doc8
+        args: []
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+        args: ['--baseline', '.secrets.baseline']
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: "data/"
+
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: debug-statements
+      - id: check-merge-conflict
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.14.5
+    hooks:
+      - id: ruff
+        name: lint
+        files: .
+        args: [ "--config", "pyproject.toml", "--fix" ]
+      - id: ruff-format
+        name: format
+        files: .
+        args: [ "--config", "pyproject.toml" ]
+
+  - repo: https://github.com/jsh9/pydoclint
+    rev: 0.8.1
+    hooks:
+      - id: pydoclint
+
+#  - repo: https://github.com/asottile/pyupgrade
+#    rev: v3.2.0
+#    hooks:
+#      - id: pyupgrade
+#        args: [ --py310-plus ]

sphinx_source_tree-0.1/.readthedocs.yaml

@@ -0,0 +1,46 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.14"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+  jobs:
+    build:
+      # The default commands for generating the HTML and pdf formats will still run.
+      htmlzip:
+        - echo "Override default build command for htmlzip format"
+        - mkdir -p $READTHEDOCS_OUTPUT/html/
+#        - mkdir -p $READTHEDOCS_OUTPUT/markdown/
+        - sphinx-build -n -b text docs $READTHEDOCS_OUTPUT/html/
+#        - sphinx-build -n -b markdown docs $READTHEDOCS_OUTPUT/markdown/
+#        - cp -R $READTHEDOCS_OUTPUT/markdown/* $READTHEDOCS_OUTPUT/html/
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+  - htmlzip
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

sphinx_source_tree-0.1/.secrets.baseline

@@ -0,0 +1,148 @@
+{
+  "version": "1.5.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "GitLabTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "IPPublicDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "OpenAIDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "PypiTokenDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TelegramBotTokenDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_baseline_file",
+      "filename": ".secrets.baseline"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    }
+  ],
+  "results": {
+    "Makefile": [
+      {
+        "type": "Secret Keyword",
+        "filename": "Makefile",
+        "hashed_secret": "ee783f2421477b5483c23f47eca1f69a1f2bf4fb",
+        "is_verified": true,
+        "line_number": 49
+      },
+      {
+        "type": "Secret Keyword",
+        "filename": "Makefile",
+        "hashed_secret": "1457a35245051927fac6fa556074300f4162ed66",
+        "is_verified": true,
+        "line_number": 52
+      }
+    ]
+  },
+  "generated_at": "2026-02-11T23:39:38Z"
+}

sphinx_source_tree-0.1/CHANGELOG.rst

@@ -0,0 +1,23 @@
+Release history and notes
+=========================
+
+`Sequence based identifiers
+<http://en.wikipedia.org/wiki/Software_versioning#Sequence-based_identifiers>`_
+are used for versioning (schema follows below):
+
+.. code-block:: text
+
+    major.minor[.revision]
+
+- It's always safe to upgrade within the same minor version (for example, from
+  0.3 to 0.3.4).
+- Minor version changes might be backwards incompatible. Read the
+  release notes carefully before upgrading (for example, when upgrading from
+  0.3.4 to 0.4).
+- All backwards incompatible changes are mentioned in this document.
+
+0.1
+---
+2026-02-12
+
+- Initial beta release.

sphinx_source_tree-0.1/CODE_OF_CONDUCT.rst

@@ -0,0 +1,144 @@
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+----------
+
+We as members, contributors, and leaders pledge to make participation in
+our community a harassment-free experience for everyone, regardless of
+age, body size, visible or invisible disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open,
+welcoming, diverse, inclusive, and healthy community.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+-  Demonstrating empathy and kindness toward other people
+-  Being respectful of differing opinions, viewpoints, and experiences
+-  Giving and gracefully accepting constructive feedback
+-  Accepting responsibility and apologizing to those affected by our
+   mistakes, and learning from the experience
+-  Focusing on what is best not just for us as individuals, but for the
+   overall community
+
+Examples of unacceptable behavior include:
+
+-  The use of sexualized language or imagery, and sexual attention or
+   advances of any kind
+-  Trolling, insulting or derogatory comments, and personal or political
+   attacks
+-  Public or private harassment
+-  Publishing others’ private information, such as a physical or email
+   address, without their explicit permission
+-  Other conduct which could reasonably be considered inappropriate in a
+   professional setting
+
+Enforcement Responsibilities
+----------------------------
+
+Community leaders are responsible for clarifying and enforcing our
+standards of acceptable behavior and will take appropriate and fair
+corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, and will
+communicate reasons for moderation decisions when appropriate.
+
+Scope
+-----
+
+This Code of Conduct applies within all community spaces, and also
+applies when an individual is officially representing the community in
+public spaces. Examples of representing our community include using an
+official e-mail address, posting via an official social media account,
+or acting as an appointed representative at an online or offline event.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported to the community leaders responsible for enforcement at
+artur.barseghyan@gmail.com. All complaints will be reviewed and
+investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security
+of the reporter of any incident.
+
+Enforcement Guidelines
+----------------------
+
+Community leaders will follow these Community Impact Guidelines in
+determining the consequences for any action they deem in violation of
+this Code of Conduct:
+
+1. Correction
+~~~~~~~~~~~~~
+
+**Community Impact**: Use of inappropriate language or other behavior
+deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders,
+providing clarity around the nature of the violation and an explanation
+of why the behavior was inappropriate. A public apology may be
+requested.
+
+2. Warning
+~~~~~~~~~~
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, for a specified period of
+time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a
+temporary or permanent ban.
+
+3. Temporary Ban
+~~~~~~~~~~~~~~~~
+
+**Community Impact**: A serious violation of community standards,
+including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No
+public or private interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, is
+allowed during this period. Violating these terms may lead to a
+permanent ban.
+
+4. Permanent Ban
+~~~~~~~~~~~~~~~~
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of
+individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction
+within the community.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the `Contributor
+Covenant <https://www.contributor-covenant.org>`__, version 2.0,
+available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by `Mozilla’s code of conduct
+enforcement ladder <https://github.com/mozilla/diversity>`__.
+
+For answers to common questions about this code of conduct, see the FAQ
+at https://www.contributor-covenant.org/faq. Translations are available
+at https://www.contributor-covenant.org/translations.

sphinx_source_tree-0.1/CONTRIBUTING.rst

@@ -0,0 +1,113 @@
+Contributor guidelines
+======================
+
+.. _documentation: https://sphinx-source-tree.readthedocs.io/#writing-documentation
+.. _testing: https://sphinx-source-tree.readthedocs.io/#testing
+.. _pre-commit: https://pre-commit.com/#installation
+.. _doc8: https://doc8.readthedocs.io/
+.. _ruff: https://beta.ruff.rs/docs/
+.. _issues: https://github.com/barseghyanartur/sphinx-source-tree/issues
+.. _discussions: https://github.com/barseghyanartur/sphinx-source-tree/discussions
+.. _pull request: https://github.com/barseghyanartur/sphinx-source-tree/pulls
+.. _support: https://sphinx-source-tree.readthedocs.io/#support
+.. _installation: https://sphinx-source-tree.readthedocs.io/#installation
+.. _features: https://sphinx-source-tree.readthedocs.io/#features
+.. _prerequisites: https://sphinx-source-tree.readthedocs.io/#prerequisites
+.. _uv: https://github.com/astral-sh/uv
+
+Developer prerequisites
+-----------------------
+pre-commit
+~~~~~~~~~~
+Refer to `pre-commit`_ for installation instructions.
+
+TL;DR:
+
+.. code-block:: sh
+
+    uv tool install pre-commit  # Install pre-commit
+    pre-commit install  # Install pre-commit hooks
+
+Installing `pre-commit`_ will ensure you adhere to the project code quality
+standards.
+
+Code standards
+--------------
+`ruff`_ and `doc8`_ will be automatically triggered by
+`pre-commit`_. Still, if you want to run checks manually:
+
+.. code-block:: sh
+
+    make pre-commit
+
+Requirements
+------------
+Requirements are compiled using `uv`_.
+
+.. code-block:: sh
+
+    make compile-requirements
+
+Virtual environment
+-------------------
+You are advised to work in virtual environment.
+
+TL;DR:
+
+.. code-block:: sh
+
+    uv sync
+    uv pip install -e .'[all]'
+
+Documentation
+-------------
+Check `documentation`_.
+
+Testing
+-------
+Check `testing`_.
+
+If you introduce changes or fixes, make sure to test them locally using
+all supported environments. For that use tox.
+
+.. code-block:: sh
+
+    tox
+
+In any case, GitHub Actions will catch potential errors, but using tox speeds
+things up.
+
+Pull requests
+-------------
+You can contribute to the project by making a `pull request`_.
+
+For example:
+
+- To fix documentation typos.
+- To improve documentation (for instance, to add new rule or fix
+  an existing rule that doesn't seem to work).
+- To introduce a new feature.
+
+**General list to go through:**
+
+- Does your change require documentation update?
+- Does your change require update to tests?
+
+**When fixing bugs (in addition to the general list):**
+
+- Make sure to add regression tests.
+
+**When adding a new feature (in addition to the general list):**
+
+- Make sure to update the documentation (check whether the `installation`_
+  or `features`_ require changes).
+
+Questions
+---------
+Questions can be asked on GitHub `discussions`_.
+
+Issues
+------
+For reporting a bug or filing a feature request use GitHub `issues`_.
+
+**Do not report security issues on GitHub**. Check the `support`_ section.

sphinx_source_tree-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Artur Barseghyan
+
+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.