Skip to main content

Srcly Server

A FastAPI server for static code analysis using lizard.

Features

  • Static Analysis: Scans the codebase for cyclomatic complexity and LOC (Lines of Code).
  • Caching: Caches analysis results in the user cache directory (see the main README) and reuses them until files change.
  • File Serving: Provides an API to read raw file contents (absolute paths).
  • API Documentation: Auto-generated Swagger UI at /docs.

Setup

This project is managed with uv.

  1. Install dependencies:

    uv sync
    

Running the Server

Start the server with hot-reloading:

uv run uvicorn app.main:app --reload

The API will be available at http://localhost:8000.

API Endpoints

Analysis

  • GET /api/analysis: Get the analysis tree. Scans unless an unchanged cached analysis exists.
  • POST /api/analysis/refresh: Force a new scan and replace the cached analysis.

Files

  • GET /api/files/content?path=/absolute/path/to/file: Get raw file content.

Client Generation

You can generate a client SDK (TypeScript, Python, etc.) using the OpenAPI schema available at http://localhost:8000/openapi.json.

Example using openapi-generator-cli:

npx @openapitools/openapi-generator-cli generate -i http://localhost:8000/openapi.json -g typescript-axios -o ../client/src/api

Metadata

Release files for srcly 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for srcly 1.7.0
File Size Uploaded Provenance Actions
srcly-1.7.0.tar.gz 4.1 MB Without provenance Details for srcly-1.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for srcly 1.7.0
File Interpreter ABI Platform Actions
srcly-1.7.0-py3-none-any.whl Python 3 none any Details for srcly-1.7.0-py3-none-any.whl

Total release size: 8.3 MB

Release files / srcly-1.7.0.tar.gz

Download URL srcly-1.7.0.tar.gz
Size 4.1 MB
Tags Source
SHA-256 checksum
How to use checksums
62d8f0c4e5b333c46c9ab17fa257638d04211934e321c32a1fe6bbdb07a2ebb9
BLAKE2b-256 checksum
How to use checksums
91e4437d76d87b5b7363ba03b2b0ac38571d6a702c294cb173b39be000f86098
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / srcly-1.7.0-py3-none-any.whl

Download URL srcly-1.7.0-py3-none-any.whl
Size 4.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3857ac20aba4f442463a087ca964f2190f81d5a17ab6fe32937ae1baf670f71f
BLAKE2b-256 checksum
How to use checksums
022cb1a629eaf9e5d9ab3fbda8d8d65918e31f0fd2e1b21741c6ef1a80f8ac11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for srcly 1.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.7.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page