{"id":15538738,"url":"https://github.com/abstra208/phat-pi","last_synced_at":"2026-01-20T03:31:35.563Z","repository":{"id":227536009,"uuid":"770944396","full_name":"Abstra208/Phat-PI","owner":"Abstra208","description":"Website for controlling a Scroll Phat HD screen","archived":false,"fork":false,"pushed_at":"2024-04-24T18:05:32.000Z","size":11602,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-09T12:36:25.016Z","etag":null,"topics":["abstra208","css","dashboard","flask","html","json","led","mit","phat-pi","pimoroni","pip","python","raspberry-pi","screen","scroll-phat-hd"],"latest_commit_sha":null,"homepage":"https://phat-pi.onrender.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Abstra208.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"abstra208"}},"created_at":"2024-03-12T12:28:39.000Z","updated_at":"2024-07-08T04:25:41.000Z","dependencies_parsed_at":"2024-04-24T19:28:46.166Z","dependency_job_id":"1be98bc0-efb9-4701-8e88-398a13fbcc1e","html_url":"https://github.com/Abstra208/Phat-PI","commit_stats":{"total_commits":62,"total_committers":2,"mean_commits":31.0,"dds":"0.032258064516129004","last_synced_commit":"92d5194db1ad751c550bf1e2e2898a80b9855281"},"previous_names":["abstra208/raspberry-pi---screen-project","abstra208/path-pi","abstra208/phat-pi"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Abstra208%2FPhat-PI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Abstra208%2FPhat-PI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Abstra208%2FPhat-PI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Abstra208%2FPhat-PI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Abstra208","download_url":"https://codeload.github.com/Abstra208/Phat-PI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247550642,"owners_count":20956984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["abstra208","css","dashboard","flask","html","json","led","mit","phat-pi","pimoroni","pip","python","raspberry-pi","screen","scroll-phat-hd"],"created_at":"2024-10-02T12:05:47.687Z","updated_at":"2026-01-20T03:31:35.538Z","avatar_url":"https://github.com/Abstra208.png","language":"HTML","funding_links":["https://ko-fi.com/abstra208"],"categories":[],"sub_categories":[],"readme":"![Phat Pi - icon](https://github.com/Abstra208/Phat-PI/blob/main/static/img/logo_name.svg)\n# Phat-PI\n\n**This project is a web application designed to control a Scroll Phat HD screen on a Raspberry Pi. It is built using Flask and uses a simple user authentication system.**\n\n## Getting Started\n\n**Before you begin, make sure you have Python installed on your Raspberry Pi. If not, you can install it by running the following command in the terminal:**\n\n```sh\nsudo apt-get update\nsudo apt-get install python3\n```\n\n**Next, navigate to where you want your file to be located, for example, documents:**\n```sh\ncd /home/pi/documents\n```\n\n**Clone this repository:**\n```sh\ngit clone https://github.com/abstra208/phat-pi.git\n```\n\n**Navigate to the project directory:**\n```sh\ncd phat-pi\n```\n\n**Install the required dependencies:**\n```sh\npip install -r requirements.txt\n```\n\n**You will also need to install the Scroll Phat HD screen API:**\n```sh\ncurl https://get.pimoroni.com/scrollphathd | bash\n```\nYou do not need to do a full install, but you still can if you want\n\n**The Scroll Phat HD screen API must only be run on a Raspberry Pi using the official OS (with or without the graphic interface)**\n\n## IMPORTANT\n\n**Before using, change the string `app.secret_key` in [`app.py`](https://github.com/abstra208/phat-pi/blob/main/app.py#L5) to something else.**\u003cbr\u003e\n**This is to keep the saved session saved securely**\u003cbr\u003e\n**If you don't have a long string in your head, you can always run `python -c 'import secrets; print(secrets.token_hex())'` to get a random string using python**\n\n## Usage\n**Run in a development server:**\n```sh\n./dev.sh\n```\nRunning the app in a development server can be useful to try the app, but not to have it always running\u003cbr\u003e\nThis will always run the app on `http://localhost:5000`\u003cbr\u003e\u003cbr\u003e\n**Run using Gunicorn:**\n```sh\n./run.sh\n```\nUsing the Gunicorn app, on the other hand, is made to always run on a server or, in our case, on a Raspberry Pi\u003cbr\u003e\nThis will always run the app on `http://localhost:8000`.\u003cbr\u003e\n\n**To stop the app, press `ctrl + c` when the terminal is focused**\n\n## Features\n\n- Users login and logout\n- Users management (Coming soon)\n- Control your Scroll Phat HD screen from anywhere on your network\n- Using a Gunicorn server for an always-running server, or a development server for testing purposes\n\n## Project Structure\n\n```\n.\n├── __pycache__/        / Include the crash and logs\n├── .github/            / Include the license and funding files\n├── app.py              / The app\n├── README.md           / Read this file before using\n├── requirements.txt    / The requirements for this project to work\n├── run.sh              / To run the project using Gunicorn\n├── dev.sh              / To run the project on a development server\n├── screen.json         / The saved screen information to show\n├── users.json          / The user's information to login\n├── screen.py           / The code to show the text on the screen\n├── static/\n│   ├── img/            / Contain image used in this project\n│   ├── users/          / Contain the user's images\n│   ├── style.css       / The style sheet for the two html page\n│   └── script.js       / The javascript for the two html page\n└── templates/\n    ├── index.html      / The main page\n    └── login.html      / The page to login\n```\n\n## Information\n\n**Contributing:**\u003cbr\u003e\nContributions are always welcome! Create a pull request or donate. See [FUNDING](/.github/FUNDING.yml) for more information.\n\n**License:**\u003cbr\u003e\nIt is distributed under the MIT License. See [LICENSE](/.github/LICENSE) for more information.\n\n**Contact:**\u003cbr\u003e\nLudovic Morin (Owner) - ludovicmorin357@hotmail.com\n\n**Project Link:**\u003cbr\u003e\n- [Phat Pi](https://github.com/abstra208/phat-pi) (Owner: Ludovic Morin)\n- [Scroll Phat HD](https://github.com/pimoroni/scroll-phat-hd) (Owner: Pimoroni Ltd)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabstra208%2Fphat-pi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabstra208%2Fphat-pi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabstra208%2Fphat-pi/lists"}