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-2.0.1.tar.gz (487.4 kB view details)

Uploaded Source

Built Distribution

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

crieur-2.0.1-py3-none-any.whl (493.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crieur-2.0.1.tar.gz
Algorithm Hash digest
SHA256 18d45ac40cc787996c8567e21ba28a68553eab17115f6417f759cdd4f0514553
MD5 cdc317343b5d6ec91d932ce2768bc57c
BLAKE2b-256 23a4ec63a3d315e8628e2f3996ce35c41f0ce0d08566c03d1335250410f21e31

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for crieur-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e9beb5cf11237cd49da719421a064e5f8e731372d4c3402d8bfecdea9f3f48be
MD5 ae1fe7692f02a069628f67331ea806f9
BLAKE2b-256 cd9bdb281b2924f6e013af6eb415bb33d8f9d375e06a3e5207258b00a0734404

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