Skip to main content

Text-based prototyping.

Project description

pip-karurada

Generates from YAML-files PDF file.

User defines page-based system (eg. WUI) using YAML files, where UI elements and navigation is declared in simple (limited) way.

Then partial PDF (A4 portrait) can be generated for show purposes to get feedback.

Declaration

Write YAML-files for every visible page/unit (including popups).

alias: simplesetofpages
imports:
  - 
    file: c_standard.yaml
    from: core # if from is missing, file path local file system to your own components

pages:
-
  page: first_page
  title: Things
  abstract: Let it be some list or greetings
  notes:
  - Note about this page, always
  content:
  -
    comp: title_bar
    title: Here will be title

Group them somehow (for bigger projects).

Make show-purposed YAML files, which collect pages for that purpose.

show:
  title: Some nice title
  imports:
  - 
    file: "./group1/pages1.yaml"
    as: mydefs

pages:
  -
    page: first_page
    from: mydes
    abstract: Just for fun
    text: Be nice and click everywhere
    notes: # after-page-notes for this show
    - "How to get back is not relevant today, let's discuss it later"
    - No need to hurry

Execute something like next (not tested yet):

from karurada import generate_show

show_file_name = 'show.yaml'
show: dict = {}

show_def: dict = interpret_string_as_yaml(read_content_of_file(show_file_name)) # use pyyaml or similar to read yaml file to dict
show = show_def["show"] # other keys may exists for description of file (eg "author"), not needed for show

new_file_name = generate_show(show, output_file, "pdf")

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

karurada-0.0.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file karurada-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: karurada-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for karurada-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9bd837b8e1ea4f85c4e9c218f68a348eec51ead856babe3e8f7a6e6abd84f8eb
MD5 887d699fb7bf51af01a69cec40603e03
BLAKE2b-256 fed18b3694183f8e0485d6b1b4740f005719816867f56b1407e0fb96b001b407

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