presenturpy


Namepresenturpy JSON
Version 0.0.0 PyPI version JSON
download
home_page
SummaryPython right-in-your-terminal presentation maker (sorta)
upload_time2023-11-20 20:35:59
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT License
keywords present presentation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Presenturpy - a python tool for terminal presentations

[Файл презентації](https://github.com/TheAmmiR/presenturpy/blob/a4a9f5e572c785022a6b793e8b63e5325a46abe1/braille.pres)

## What is it?

A library, coded in 24 hours or so for a school project. Allows to place text blocks in 2D coordinates and make individual slides out of them.
No pip dependencies btw

## Why?

Because check this out:
![image](https://github.com/TheAmmiR/presenturpy/blob/master/screenshots/screenshot1.png?raw=true)
[terminal, default settings](https://github.com/Swordfish90/cool-retro-term)

## Usage

Loading from file (file syntax ↡):

```py
from presenturpy import Presentation

presentation = Presentation.load_from_file("path")
presentation.show()
```

Direct usage:

```py
from presenturpy import Alignment, Presentation, SlideBuilder

slides = []
slides.append(
    SlideBuilder() # (x, y),    (0,0) is upper left
    .add_text("Hello, world!", (Alignment.MIDDLE, Alignment.MIDDLE))
    .set_duration(5) # seconds
    .build()
)
slides.append(
    SlideBuilder()
    .add_text(
        "Thanks for watching!", (Alignment.MIDDLE, Alignment.BOTTOM),
        transition=True 
    )
    .set_confirmation(True)
    .build()
)

# If the final slide has a set duration, the slide will be shown until the time runs out.

presentation = Presentation(slides)
presentation.show()
```

### File syntax

Example file:

```fix
[5[,0|.0] s|sec|seconds]        # Duration, needs confirmation if none

```lu m;10[;0]                  # Pivot corner (the one you write coordinates for) 
Example text                    # (lu|ld|ru|rd)
Because I have to explain       # Side indentation - wraps every line in a number of spaces on each side
a bunch of stuff here           # xpos;ypos - allows negative absolute values.
yeah                            # l|m|r for horizontal alignment, u|m|d for vertical
```+                            # + allows word wrapping if you don't mind having 1 letter of the word on the next line sometimes
                                # If you do, try to adjust side indentation.

---                             # Slide delimiter

# Next slide here

```

___

## To-do (maybe)

- [x] Refactoring (kinda)
- [x] Even more refactoring
- [ ] Renaming corners
- [ ] Easy slide duplication

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "presenturpy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "present,presentation",
    "author": "",
    "author_email": "theammir <the@ammir.dev>, valsoray-dev <me@valsoray.dev>",
    "download_url": "https://files.pythonhosted.org/packages/6f/1f/63a0d37bbe104a0b9e76f4904355690a39e6656e3d3a2bd89f4181f0a110/presenturpy-0.0.0.tar.gz",
    "platform": null,
    "description": "# Presenturpy - a python tool for terminal presentations\r\n\r\n[\u0424\u0430\u0439\u043b \u043f\u0440\u0435\u0437\u0435\u043d\u0442\u0430\u0446\u0456\u0457](https://github.com/TheAmmiR/presenturpy/blob/a4a9f5e572c785022a6b793e8b63e5325a46abe1/braille.pres)\r\n\r\n## What is it?\r\n\r\nA library, coded in 24 hours or so for a school project. Allows to place text blocks in 2D coordinates and make individual slides out of them.\r\nNo pip dependencies btw\r\n\r\n## Why?\r\n\r\nBecause check this out:\r\n![image](https://github.com/TheAmmiR/presenturpy/blob/master/screenshots/screenshot1.png?raw=true)\r\n[terminal, default settings](https://github.com/Swordfish90/cool-retro-term)\r\n\r\n## Usage\r\n\r\nLoading from file (file syntax \u21a1):\r\n\r\n```py\r\nfrom presenturpy import Presentation\r\n\r\npresentation = Presentation.load_from_file(\"path\")\r\npresentation.show()\r\n```\r\n\r\nDirect usage:\r\n\r\n```py\r\nfrom presenturpy import Alignment, Presentation, SlideBuilder\r\n\r\nslides = []\r\nslides.append(\r\n    SlideBuilder() # (x, y),    (0,0) is upper left\r\n    .add_text(\"Hello, world!\", (Alignment.MIDDLE, Alignment.MIDDLE))\r\n    .set_duration(5) # seconds\r\n    .build()\r\n)\r\nslides.append(\r\n    SlideBuilder()\r\n    .add_text(\r\n        \"Thanks for watching!\", (Alignment.MIDDLE, Alignment.BOTTOM),\r\n        transition=True \r\n    )\r\n    .set_confirmation(True)\r\n    .build()\r\n)\r\n\r\n# If the final slide has a set duration, the slide will be shown until the time runs out.\r\n\r\npresentation = Presentation(slides)\r\npresentation.show()\r\n```\r\n\r\n### File syntax\r\n\r\nExample file:\r\n\r\n```fix\r\n[5[,0|.0] s|sec|seconds]        # Duration, needs confirmation if none\r\n\r\n```lu m;10[;0]                  # Pivot corner (the one you write coordinates for) \r\nExample text                    # (lu|ld|ru|rd)\r\nBecause I have to explain       # Side indentation - wraps every line in a number of spaces on each side\r\na bunch of stuff here           # xpos;ypos - allows negative absolute values.\r\nyeah                            # l|m|r for horizontal alignment, u|m|d for vertical\r\n```+                            # + allows word wrapping if you don't mind having 1 letter of the word on the next line sometimes\r\n                                # If you do, try to adjust side indentation.\r\n\r\n---                             # Slide delimiter\r\n\r\n# Next slide here\r\n\r\n```\r\n\r\n___\r\n\r\n## To-do (maybe)\r\n\r\n- [x] Refactoring (kinda)\r\n- [x] Even more refactoring\r\n- [ ] Renaming corners\r\n- [ ] Easy slide duplication\r\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Python right-in-your-terminal presentation maker (sorta)",
    "version": "0.0.0",
    "project_urls": {
        "Homepage": "https://github.com/theammir/presenturpy",
        "Issues": "https://github.com/theammir/presenturpy/issues",
        "Repository": "https://github.com/theammir/presenturpy"
    },
    "split_keywords": [
        "present",
        "presentation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "74740d659ddbeb09509e8f429a7cfc5d0325c02be028fde65fef3ff847d328f3",
                "md5": "8816c9f9857e4b93e13474d4371a5af5",
                "sha256": "7ebe59522fb81c10c5b3b6f7f55191c7767f9ecad6e7e83fbcb154ad078d9995"
            },
            "downloads": -1,
            "filename": "presenturpy-0.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8816c9f9857e4b93e13474d4371a5af5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 5928,
            "upload_time": "2023-11-20T20:35:53",
            "upload_time_iso_8601": "2023-11-20T20:35:53.164429Z",
            "url": "https://files.pythonhosted.org/packages/74/74/0d659ddbeb09509e8f429a7cfc5d0325c02be028fde65fef3ff847d328f3/presenturpy-0.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f1f63a0d37bbe104a0b9e76f4904355690a39e6656e3d3a2bd89f4181f0a110",
                "md5": "7d81829d8d4478dd07145ba4cf11459b",
                "sha256": "9246fad31abbabb67c8bfe2112ba25ff228b90cacd413239c18eb06afb4fbcf9"
            },
            "downloads": -1,
            "filename": "presenturpy-0.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7d81829d8d4478dd07145ba4cf11459b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1953418,
            "upload_time": "2023-11-20T20:35:59",
            "upload_time_iso_8601": "2023-11-20T20:35:59.091119Z",
            "url": "https://files.pythonhosted.org/packages/6f/1f/63a0d37bbe104a0b9e76f4904355690a39e6656e3d3a2bd89f4181f0a110/presenturpy-0.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-20 20:35:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "theammir",
    "github_project": "presenturpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "presenturpy"
}
        
Elapsed time: 0.13993s