Skip to main content

Crieur — A Static Site Generator from Stylo sources.

Either for a journal or a blog or whatever you want to do! Everything is configurable at the template-level.

Run

uv run --with crieur crieur stylo <stylo-corpus-id-1> <stylo-corpus-id-2> …
uv run --with crieur crieur generate serve --title PHLiT

Help

Commands

usage: crieur [-h]  ...

options:
  -h, --help   Show this help message and exit

Available commands:
  
    version    Return the current version.
    init       Generate the default TOML configuration file.
    build      Download Stylo sources, generate the website and optionnaly
               serve it.
    generate   Generate a new revue website.
    stylo      Initialize a new revue to current directory from Stylo.
    templates  Fetch a theme from a git repository.
    serve      Serve an HTML book from `repository_path`/`target_path` or
               current directory/public.

Command: init

usage: crieur init [-h] [--name NAME]

options:
  -h, --help       show this help message and exit
  --name, -n NAME  Custom name for the TOML file (default: site.toml).

Command: build

usage: crieur build [-h] [--then-serve] config_path

positional arguments:
  config_path   Path to the TOML configuration file.

options:
  -h, --help    show this help message and exit
  --then-serve  To serve the build target directory respecting the TOML
                configuration.

Command: generate

usage: crieur generate [-h] [--title TITLE] [--base-url BASE_URL]
                       [--extra-vars EXTRA_VARS] [--target-path TARGET_PATH]
                       [--source-path SOURCE_PATH]
                       [--statics-path STATICS_PATH]
                       [--templates-path TEMPLATES_PATH] [--csl-path CSL_PATH]
                       [--without-statics] [--without-search] [--blog]
                       [--flat] [--feed-limit FEED_LIMIT] [--exports EXPORTS]
                       [--linkable-blocks]

options:
  -h, --help            show this help message and exit
  --title, -t TITLE     Title of the website (default: Crieur).
  --base-url BASE_URL   Base URL of the website, ending with / (default: /).
  --extra-vars EXTRA_VARS
                        stringified JSON extra vars passed to the templates.
  --target-path TARGET_PATH
                        Path where site is built (default: /public/).
  --source-path SOURCE_PATH
                        Path where stylo source were downloaded (default:
                        /sources/).
  --statics-path STATICS_PATH
                        Path where statics are located (default:
                        @crieur/statics/).
  --templates-path TEMPLATES_PATH
  --csl-path CSL_PATH   Path to the CSL applied for bibliography (default:
                        @crieur/styles/apa.csl).
  --without-statics     Do not copy statics if True (default: False).
  --without-search      Do not generate search page if True (default: False).
  --blog, -b            Use the built-in blog theme if True, overrides
                        statics/templates options (default: False).
  --flat, -f            Use a flat tree structure for Article URLs if True
                        (default: False, except for blog).
  --feed-limit FEED_LIMIT
                        Number of max items in the feed (default: 10).
  --exports, -e EXPORTS
                        Kind of exports you want to expose, comma separated
                        (pdf, xml-tei, etc).
  --linkable-blocks     Add anchors to paragraphs and headers if True
                        (default: False).

Command: serve

usage: crieur serve [-h] [--repository-path REPOSITORY_PATH]
                    [--target-path TARGET_PATH] [--port PORT]

options:
  -h, --help            show this help message and exit
  --repository-path REPOSITORY_PATH
                        Absolute or relative path to book’s sources (default:
                        current).
  --target-path TARGET_PATH
                        Relative path to build target (default: public).
  --port, -p PORT       Port to serve the book from (default=8000)

Command: stylo

usage: crieur stylo [-h] [--pages PAGES] [--exports EXPORTS]
                    [--stylo-instance STYLO_INSTANCE]
                    [--stylo-export STYLO_EXPORT] [--force-download]
                    [stylo_ids ...]

positional arguments:
  stylo_ids             Corpus ids from Stylo, separated by commas.

options:
  -h, --help            show this help message and exit
  --pages, -p PAGES     Corpus id from Stylo to load satellite pages (contact,
                        etc).
  --exports, -e EXPORTS
                        Kind of exports you want to download, comma separated
                        (pdf, xml-tei, etc).
  --stylo-instance STYLO_INSTANCE
                        Instance of Stylo (default: stylo.huma-num.fr).
  --stylo-export STYLO_EXPORT
                        Stylo export URL (default: https://export.stylo.huma-
                        num.fr).
  --force-download      Force download of sources from Stylo (default: False).

Command: templates

usage: crieur templates [-h] [--repo-url REPO_URL] [--source-path SOURCE_PATH]
                        [--quiet]

options:
  -h, --help            show this help message and exit
  --repo-url REPO_URL   Repository URL, ending with / (default:
                        https://gitlab.huma-num.fr/ecrinum/crieur-templates/).
  --source-path SOURCE_PATH
                        The path within the git repository to the theme files
                        (e.g.: blogs/blog-purple).
  --quiet, -q           Do not prompt for file overrides if True (default:
                        False).

Release files for crieur 4.1.6

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

Source distribution (sdist)

Source distribution for crieur 4.1.6
File Size Uploaded
crieur-4.1.6.tar.gz 720.3 kB Details

Built distribution (wheel)

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

Total release size: 1.5 MB

Release files / crieur-4.1.6.tar.gz

Download URL crieur-4.1.6.tar.gz
Size 720.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a7515a3c3b5f2f770a61cc376233d940529807dc6664961f7cada4613722f218
BLAKE2b-256 checksum
How to use checksums
cbc3abb515c0bb159ed98f8a0d8b4f57925f9d6d6a1fb593e18e3f5987ebed61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.17.0 {"ci":null,"cpu":"arm64","distro":{"name":"macOS","version":"26.5.1"},"implementation":{"name":"CPython","version":"3.13.0"},"installer":{"name":"hatch","version":"1.17.0"},"openssl_version":"OpenSSL 3.0.15 3 Sep 2024","python":"3.13.0","system":{"name":"Darwin","release":"25.5.0"}} HTTPX2/2.5.0

Release files / crieur-4.1.6-py3-none-any.whl

Download URL crieur-4.1.6-py3-none-any.whl
Size 730.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d69c9233cf29909e199b73d1411418ea32989c209d7d8806df80eb0a88bc50e0
BLAKE2b-256 checksum
How to use checksums
3f146d256ec4f9aeedd5b6881d879f230eb4219755807b7f0a1b69f4360adf0d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.17.0 {"ci":null,"cpu":"arm64","distro":{"name":"macOS","version":"26.5.1"},"implementation":{"name":"CPython","version":"3.13.0"},"installer":{"name":"hatch","version":"1.17.0"},"openssl_version":"OpenSSL 3.0.15 3 Sep 2024","python":"3.13.0","system":{"name":"Darwin","release":"25.5.0"}} HTTPX2/2.5.0

Release history Release notifications | RSS feed

This release

4.1.6 This release

2 release files

4.1.5

2 release files

4.1.4

2 release files

4.1.3

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.1

2 release files

4.0.0

2 release files

3.5.0

2 release files

3.4.0

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.8.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.12.0

2 release files

1.10.0

2 release files

1.9.1

2 release files

1.9.0

2 release files

1.8.1

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

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