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]
                       [--statics-path STATICS_PATH]
                       [--templates-path TEMPLATES_PATH] [--csl-path CSL_PATH]
                       [--without-statics] [--feed-limit FEED_LIMIT]

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).
  --feed-limit FEED_LIMIT
                        Number of max items in the feed (default: 10).

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.12.0.tar.gz (64.5 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.12.0-py3-none-any.whl (71.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crieur-1.12.0.tar.gz
Algorithm Hash digest
SHA256 b48f2c432c4f919724b7337c7e2f186be0b705f11ec57241f4fd4c3a8baa9a17
MD5 5666cfd8765cd6eb16e4cbbf3d4b7cd2
BLAKE2b-256 c85c70d77b6f8a8af32c1d92b6c4138145b7c4423624c115884ebabcfa907b00

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for crieur-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 327957e5954379ec4e4f50d6e9d2dc49daf990dc0c1488c319ae4d5a7dc2cfe3
MD5 fcfe662ca564cfe9ac403013167b2a69
BLAKE2b-256 a53df17dd8fe27e173201d5927c9793ad8a7e32ebe0e517ccc751de290f9f7d3

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