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] [--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
  --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.8.1.tar.gz (49.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.8.1-py3-none-any.whl (53.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for crieur-1.8.1.tar.gz
Algorithm Hash digest
SHA256 8e43acb89f171de90ea77a49f79b227c5489146fe325514e0bfe23d711f942a2
MD5 4a80388bf9355057a1b0470880acc9e5
BLAKE2b-256 1bf1ecd3e1692b60a2de1ebd2323799209c7a9aa89da7c707e32d3cad49381cc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for crieur-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9822336e32ea04dc6c1d49e64b428f9f591cb4876a36ea64a2cd4be0dcef3150
MD5 e933d026d3996c1376bba4a6b07c6d11
BLAKE2b-256 fb05a1303992d2be9727541fd7bfb12c02134a0c89576bc46fc80269b57fb4e0

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