PyCssStyleguide

This is a Python library and commandline script to build a design styleguide from a CSS manifest file.

Opposed to many styleguide builders this does not require to documentate styles from your stylesheets. Instead it is based on Sass variables to build a map of your style rules.

Features

• Python interface to load a CSS manifest and return it as a Python dictionnary or JSON data;

• Commandline script to parse a CSS manifest and dump a JSON of parsed references;

• (Optional) Sass mixin library to write CSS manifest from your Sass project settings;

• (Optional) Django mixin and view to load manifest from your project or application;

Links

• Read the documentation on Read the docs;

• Download its PyPi package;

• Clone it on its Github repository;

Dependencies

• Python>=3.8;

• tinycss2>=1.1.0;

• Click>=8.0;

• colorlog>=6.8.2;

Credits

Logo vector and icon by SVG Repo.

Contents

• Overview
  • Introduction
  • Basic example
  • Workflow
• Install
• Usage
  • Create a manifest
  • Demonstration settings
  • Manifest loader
  • Samples
    • The full automatic way
    • Automatic with name exclusions
    • Explicit reference names
• Manifest
  • Rule format
  • Meta rule
    • styleguide-metas-compiler
    • styleguide-metas-references
  • Reference rule
    • Serialization structures
    • Item separator
• Sass mixin library
  • For Libsass compiler
  • For Dartsass compiler
• Commandline scripts
  • Version display
  • Manifest parser
• Core API
  • Modules
    • Nomenclature
    • FORBIDDEN_PREFIXES
    • RESERVED_RULE_NAMES
    • RESERVED_PROPERTY_NAMES
    • REFERENCE_STRUCTURES
    • is_reserved_rule()
    • is_reserved_property()
    • is_valid_rule()
    • is_valid_property()
    • Parser
    • TinycssSourceParser
    • Serializer
    • ManifestSerializer
    • Manifest object
    • Manifest
    • Django mixin and view

About the project

• Development
• Changelog
• Migrations