fastsandpm

User Documentation

  • Package Manifest Reference
    • The Manifest Format
      • The [package] section
        • The name field
        • The version field
        • The description field
        • The authors field
        • The readme field
        • The flist field
      • The [dependencies] section
      • The [optional_dependencies] section
        • Format Equivalence
      • The [registries] section
        • Git Registries
        • Package Index Registries
        • Path Registries
        • Complete Registry Example
        • Default Registries
    • Specifying Dependencies
      • Package Index Specifier
        • Dependencies from Other Registries
      • Git Specifier
        • Git Commit & Tag Specifiers
        • Git Branch Specifiers
        • Git Version Specifiers
      • Path Specifiers
    • Version Specifiers
      • Direct Versions
      • Caret Requirements
      • Comparison Requirements and Ranges
      • Pre-Releases
    • Environment Variables
  • Library User Guide
    • Installation
    • Command Line Interface
    • Python API
      • Command Line Interface
        • Basic Usage
        • Command Reference
        • Examples
        • Exit Codes
        • Typical Workflow
        • See Also

Developer Documentation

  • Contributing
    • Prerequisites
    • Getting Setup
    • Development Workflow
      • Testing - pytest
      • Type Checking - mypy
      • Code Quality - ruff
      • Integration Testing - tox
    • Code Formatting Guidelines
    • Branching and Commit Conventions
      • Branch Naming
      • Commit Messages
    • Before Making a PR
    • Debugging Tips
      • Running Specific Tests
      • Type Checking with Details
      • Building Documentation Locally
    • Common Issues and Troubleshooting
      • UV Command Not Found
      • Import Errors When Running Tests
      • Tests Pass Locally but Fail in CI
  • Changelog
    • 0.1.2
      • Fixed
    • 0.1.1
      • Fixed
    • 0.1.0
      • Added

API

  • fastsandpm API
    • __version__
    • __author__
    • fastsandpm.cli API
      • create_parser()
      • find_manifest()
      • main()
      • parse_args()
      • setup_logging()
    • fastsandpm.dependencies API
      • fastsandpm.dependencies.candidates API
        • candidate_factory()
        • Candidate
        • GitCandidate
        • PackageIndexCandidate
        • PathCandidate
      • fastsandpm.dependencies.provider API
        • provider.FastSandReqInfo
        • provider.FastSandReporter
        • resolve()
        • FastSandProvider
        • ResolveResult
      • fastsandpm.dependencies.requirements API
        • BranchGitRequirement
        • CommitGitRequirement
        • GitRequirement
        • LibraryRequirement
        • PackageIndexRequirement
        • PathRequirement
        • TaggedGitRequirement
        • VersionedGitRequirement
    • fastsandpm.install API
      • build_library()
      • library_from_manifest()
    • fastsandpm.manifest API
      • manifest.MANIFEST_FILENAME
      • get_manifest()
      • get_manifest_from_bytes()
      • Dependencies
        • Dependencies.parse_dependencies()
        • Dependencies.append()
        • Dependencies.get_by_name()
        • Dependencies.insert()
        • Dependencies.validate_unique_names()
        • Dependencies.model_config
      • Manifest
        • Manifest.parse_optional_dependencies()
        • Manifest.dependencies
        • Manifest.model_config
        • Manifest.optional_dependencies
        • Manifest.package
        • Manifest.registries
      • Package
        • Package.validate_name_not_empty()
        • Package.authors
        • Package.description
        • Package.flist
        • Package.model_config
        • Package.name
        • Package.readme
        • Package.version
      • ManifestNotFoundError
      • ManifestParseError
    • fastsandpm.registries API
      • GitRegistry
        • GitRegistry.model_config
        • GitRegistry.name
        • GitRegistry.remote
      • PackageIndexRegistery
        • PackageIndexRegistery.index
        • PackageIndexRegistery.model_config
        • PackageIndexRegistery.name
      • PathRegistry
        • PathRegistry.model_config
        • PathRegistry.name
        • PathRegistry.path
      • Registries
        • Registries.parse_dependencies()
        • Registries.add_default_registries()
        • Registries.get_by_name()
        • Registries.git_registries()
        • Registries.package_index_registries()
        • Registries.path_registries()
        • Registries.validate_unique_names()
        • Registries.model_config
      • DependencyNotFoundError
    • fastsandpm.versioning API
      • fastsandpm.versioning.library_version API
        • LibraryVersion
        • PreReleaseStage
      • fastsandpm.versioning.specifier API
        • specifier.ComparisonOperator
        • find_compatible_version()
        • meets_constraints()
        • version_specifier_from_str()
        • CaretVersionSpecifier
        • ComparisonVersionSpecifier
        • DirectVersionSpecifier
        • RangeVersionSpecifier
        • VersionSpecifier
fastsandpm
  • Search

© Copyright 2026, Benjamin Davis.

Built with Sphinx using a theme provided by Read the Docs.