Skip to main content

A Static Revue Generator.

Project description

Crieur — A Static Revue Generator.

With sources from Stylo corpora.

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


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

Available commands:
  
    version   Return the current version.
    generate  Generate a new revue website.
    stylo     Initialize a new revue to current directory from Stylo.
    serve     Serve an HTML book from `repository_path`/public or current
              directory/public.

Command: generate

                       [--extra-vars EXTRA_VARS] [--target-path TARGET_PATH]
                       [--source-path SOURCE_PATH]
                       [--templates-path TEMPLATES_PATH] [--without-statics]

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/).
  --templates-path TEMPLATES_PATH
  --without-statics     Do not copy statics if True (default: False).

Command: serve


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

Command: stylo

                    [--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
  --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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crieur-1.3.1.tar.gz (46.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crieur-1.3.1-py3-none-any.whl (50.2 kB view details)

Uploaded Python 3

File details

Details for the file crieur-1.3.1.tar.gz.

File metadata

  • Download URL: crieur-1.3.1.tar.gz
  • Upload date:
  • Size: 46.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for crieur-1.3.1.tar.gz
Algorithm Hash digest
SHA256 e85ceb0c9b1851e57dfbe5df54d9868b2806ad822f633aaadbce52cf20f082e4
MD5 5333fbfe931ba308279f1b05a301370f
BLAKE2b-256 e91f1a9827983a69faaddbc2b89aa162e87a271d00ad6798a69a565870047e97

See more details on using hashes here.

File details

Details for the file crieur-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: crieur-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 50.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for crieur-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0dd49cf0ef4dd7018bc9ecd4c80db89100fb7afba9f45b8fa05cd9a82082169c
MD5 2dcbd6462af7e1a50983f45be4b71347
BLAKE2b-256 88cc318fa2b502cedcd9b7c9a412007645fd4d084f33064c31246ce01f18b0d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page