cMeta Documentation

Welcome to cMeta v0.32.1 documentation!

cMeta v0.32.1 Contents:

• cMeta Project Home
  • Core idea
  • What you get
  • Use cases
  • Quickstart
  • Documentation
  • Attribution and reuse
  • Project information
  • Links

Guides:

• cMeta documentation
  • Guides
  • Building the API reference
• Why cMeta
  • The problem
  • The aim
  • The approach
  • Design principles
  • FAIR by construction
  • What people use it for
  • What it is not
  • Where this came from
  • Next
• Installing cMeta
  • Requirements
  • Option 1 — uv tool (a global cx, recommended)
  • Option 2 — uv + a project virtual environment
  • Option 3 — pip + a project virtual environment
  • Latest from source
  • Choosing where repositories live
  • Serial or async — choosing extras
  • Verify the installation
  • Python interface
  • Optional configuration
  • Working with artifact repositories
  • Troubleshooting
• Common commands and tips
  • Discovery — finding your way around
  • cx . — work from the current directory
  • Artifacts
  • UIDs
  • Repositories
  • Configuration
  • Index and cache
  • Output, scripting and debugging
  • Flag syntax
  • Handy one-liners
• Using cMeta
  • 1. Mental model in 60 seconds
  • 2. First checks after install
  • 3. Common CLI flags
  • 4. Built-in categories (plugins)
  • 5. Working with artifacts
  • 6. Resolving categories & artifacts (alias / UID / alias,UID)
  • 7. cMeta repositories
  • 8. Configuring categories via config artifacts
  • 9. Adding a new category (plugin)
  • 10. Adding artifacts of a category
  • 11. Fast index & when to cx --reindex
  • 12. Scaling a category to very many artifacts
  • 13. Where to look next
• Error handling
  • 1. The return contract
  • 2. Checking a result
  • 3. Soft errors — return code 16
  • 4. Raising errors
  • 5. Handling errors from the CLI (scripts, CI, agents)
  • 6. Debugging — making cMeta raise
  • 7. Debugging in an IDE
  • 8. Quick reference
• Async and concurrency
  • 1. Two ways to run
  • 2. Serial use
  • 3. Async use (CMetaAsync)
  • 4. Concurrency safety guards
  • 5. Choosing a mode
• Working with configs
  • Commands
  • Examples
  • Keep secrets private
  • See also
• Connecting to the cTuning.ai platform
  • Prerequisites
  • Configure access
  • Test the connection
  • Keep your API token private
  • See also
• History and background
  • Lineage
  • Related publications and talks
  • How to cite
  • License note
• Known issues and planned improvements
  • KI-001
  • KI-002
  • KI-003
  • Adding an entry

API Reference:

• API Reference (v0.32.1)
  • cmeta.category module
  • cmeta.category_api_v1 module
  • cmeta.cli module
  • cmeta.config module
  • cmeta.core module
  • cmeta.core_async module
  • cmeta.packages module
  • cmeta.repos module
  • cmeta.utils.cli module
  • cmeta.utils.common module
  • cmeta.utils.files module
  • cmeta.utils.names module
  • cmeta.utils.net module
  • cmeta.utils.sys module
  • cmeta.version module

Indices and tables

• Index

• Module Index

• Search Page