sourcecode 0.26.0__tar.gz → 0.27.0__tar.gz

sourcecode-0.27.0/CONTRIBUTING.md

@@ -0,0 +1,184 @@
+# Contributing to sourcecode
+
+Thank you for your interest in contributing. This document covers how to set up a development environment, run tests, and submit changes.
+
+---
+
+## Code of Conduct
+
+This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
+
+---
+
+## Getting started
+
+### Prerequisites
+
+- Python 3.9+
+- Git
+
+### Local setup
+
+```bash
+git clone https://github.com/sourcecode-ai/sourcecode
+cd sourcecode
+pip install -e ".[dev]"
+```
+
+This installs `sourcecode` in editable mode with all development dependencies (`pytest`, `ruff`, `mypy`).
+
+### Run the CLI locally
+
+```bash
+sourcecode . --agent
+sourcecode . prepare-context explain
+```
+
+### Run tests
+
+```bash
+pytest tests/
+```
+
+Run a single file:
+```bash
+pytest tests/test_detector_nodejs.py -v
+```
+
+---
+
+## Project structure
+
+```
+src/sourcecode/
+├── cli.py                  # CLI entry point (Typer)
+├── scanner.py              # File tree scanning
+├── schema.py               # Output schema (SourceMap + all dataclasses)
+├── serializer.py           # JSON/YAML output + agent_view/compact_view
+├── summarizer.py           # Natural language project summary
+├── architecture_summary.py # Architecture description generation
+├── prepare_context.py      # Task-specific context compilation
+├── relevance_scorer.py     # File operational relevance scoring
+├── runtime_classifier.py   # Monorepo package role classification
+├── git_analyzer.py         # Git context extraction
+├── detectors/              # Stack/framework/entry point detectors
+│   ├── python.py
+│   ├── nodejs.py
+│   ├── go.py
+│   └── ...
+└── ...
+tests/
+├── test_detector_nodejs.py
+├── test_summarizer.py
+└── ...
+```
+
+---
+
+## Making changes
+
+### Adding a new language detector
+
+1. Create `src/sourcecode/detectors/<language>.py`
+2. Implement the `BaseDetector` interface (see `detectors/base.py`)
+3. Register it in `detectors/__init__.py` → `build_default_detectors()`
+4. Add tests in `tests/test_detector_<language>.py`
+
+### Modifying the output schema
+
+The schema is defined in `schema.py` as Python dataclasses. All fields must have defaults so that existing consumers are not broken. Add new fields at the end of the relevant dataclass with `Optional[T] = None` or `list[T] = field(default_factory=list)`.
+
+### Modifying relevance scoring
+
+Relevance scoring lives in `relevance_scorer.py` (file-level scoring) and `runtime_classifier.py` (monorepo package-level classification). Changes here affect what agents see first — test with realistic repos.
+
+---
+
+## Code style
+
+This project uses `ruff` for linting and formatting.
+
+```bash
+ruff check src/ tests/
+ruff format src/ tests/
+```
+
+Type checking with `mypy`:
+```bash
+mypy src/
+```
+
+Rules:
+- All public functions must have type annotations
+- Docstrings are optional but welcome for non-obvious logic
+- No inline comments explaining what the code does — names should do that
+- Comments only for non-obvious constraints or workarounds
+
+---
+
+## Commits
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat: add Go module graph support
+fix: exclude benchmark entrypoints from production ranking
+docs: update agent workflow examples
+refactor: simplify relevance scorer baseline calculation
+test: add coverage for monorepo runtime classifier
+```
+
+Keep commits atomic. One logical change per commit.
+
+---
+
+## Pull requests
+
+1. Fork the repository and create a branch: `git checkout -b feat/my-feature`
+2. Make your changes with tests
+3. Run the full test suite: `pytest tests/`
+4. Run lint: `ruff check src/ tests/`
+5. Open a PR against `main`
+
+**PR description should include:**
+- What changed and why
+- How to test it manually
+- Any breaking changes or schema additions
+
+---
+
+## Reporting bugs
+
+Open an issue with:
+- `sourcecode --version` output
+- Command you ran
+- Expected behavior
+- Actual behavior / error output
+- OS and Python version
+
+---
+
+## Proposing features
+
+Open an issue with the `feature` label. Describe:
+- The problem you're solving
+- Why it belongs in `sourcecode` (vs. a wrapper or downstream tool)
+- What the output or behavior would look like
+
+Features that add flags without clear agent-oriented use cases will be declined. Complexity is a cost.
+
+---
+
+## What we will NOT merge
+
+- LLM API calls inside the analysis pipeline
+- Network requests during analysis (except opt-in telemetry)
+- New flags that only serve human-readable output, not agent consumption
+- Breaking changes to the output schema without a migration path
+- Features that compromise the determinism guarantee
+
+---
+
+## License
+
+By submitting a contribution, you agree that it will be licensed under the [Apache 2.0 License](LICENSE).

sourcecode-0.27.0/LICENSE

@@ -0,0 +1,186 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other formats.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submit" means any form of electronic, verbal, or
+      written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Contributor
+      Contribution constitutes direct or contributory patent infringement,
+      then any patent rights granted to You under this License for that Work
+      shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as separate terms and conditions for their use,
+      reproduction, and distribution, or alongside or as supplement to
+      any license terms for such Derivative Works as a whole, provided
+      Your use, reproduction, and distribution of the Work otherwise
+      complies with the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 sourcecode contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.