syntactic

Make syntactically valid names out of strings.

Installation

uv method

This is a Python package hosted on PyPI as acidgenomics-syntactic. The import name is unchanged: syntactic. We recommend using uv to install.

uv add acidgenomics-syntactic

Or with pip:

pip install acidgenomics-syntactic

Conda method

Configure Conda to use the Bioconda channels.

# Don't install recipe into base environment.
name='syntactic'
conda create --name="$name" "$name"
conda activate "$name"
python -c 'import syntactic'

Usage

from syntactic import (
    camel_case,
    snake_case,
    kebab_case,
    dotted_case,
    upper_camel_case,
    make_names,
    make_words,
    make_title,
    make_label,
    capitalize,
    sentence_case,
    autopad_zeros,
    syntactic_rename,
)

# Case conversion
snake_case(["human genomeVersion", "sampleID"])
# ['human_genome_version', 'sample_id']

camel_case(["human_genome_version", "sample_id"])
# ['humanGenomeVersion', 'sampleId']

upper_camel_case(["human_genome_version", "sample_id"])
# ['HumanGenomeVersion', 'SampleId']

kebab_case(["human genomeVersion", "sampleID"])
# ['human-genome-version', 'sample-id']

dotted_case(["human genomeVersion", "sampleID"])
# ['human.genome.version', 'sample.id']

# Make syntactically valid names
make_names(["%GC", "1st sample", "hello world"])
# ['GC', 'X1st_sample', 'hello_world']

# Human-readable conversions
make_words(["nGene", "log10GenesPerUMI"])
# ['n gene', 'log10 genes per UMI']

make_title(["nGene", "log10GenesPerUMI"])
# ['N gene', 'Log10 genes per UMI']

# Zero padding
autopad_zeros([1, 10, 100])
# ['001', '010', '100']

# File renaming
syntactic_rename("/path/to/dir", fun="snake_case")

Function Reference

License

Apache-2.0 — Copyright 2026 Acid Genomics LLC — see LICENSE.