https://github.com/thinkr-open/signature.py
A Shiny App with Python
https://github.com/thinkr-open/signature.py
email-editor python shiny shiny-apps shiny-python
Last synced: 5 months ago
JSON representation
A Shiny App with Python
- Host: GitHub
- URL: https://github.com/thinkr-open/signature.py
- Owner: ThinkR-open
- License: mit
- Created: 2024-07-14T10:29:19.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-01-16T12:28:43.000Z (5 months ago)
- Last Synced: 2025-01-16T12:52:57.454Z (5 months ago)
- Topics: email-editor, python, shiny, shiny-apps, shiny-python
- Language: JavaScript
- Homepage: https://signature-py.vercel.app/
- Size: 20.3 MB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Signature.py 
[](https://www.figma.com/proto/u95KvEqgWLB8arxt7saZcJ/%7Bsignature%7D?node-id=705-5&t=xevegkmzONTrRyR3-8&scaling=contain&content-scaling=fixed&page-id=0%3A1&starting-point-node-id=705%3A5&hide-ui=1)
[](https://github.com/ThinkR-open/signature.py/actions/workflows/run-pytest.yaml)
This is the python version of the [`{signature.r}`](https://github.com/ThinkR-open/signature.r) and [`{signature.js}`](https://github.com/ThinkR-open/signature.js) application.
This application provides a graphical interface to streamline the creation and maintenance of your email signature.
No more wrestling with images or getting tangled up in HTML code; the application offers a set of fields to update your signature easily.
Simply enter your name, first name, email, and other necessary information to populate your signature.
Additionally, the application allows you to copy the HTML code with a single button click, making it easy to paste into your email client settings.
Lastly, updating the banner (the image at the bottom of the signature) and the associated link for redirection is straightforward. You no longer need to request everyone to update their signature individually for these changes.
## Winner of the 2024 Shiny Contest
đ This project won the 2024 Shiny Contest for the best Shiny application with Python.
More details on the contest can be found [here](https://posit.co/blog/winners-of-the-2024-shiny-contest/).
## Demo
đšī¸ Try the app at:
[https://signature-py.vercel.app/](https://signature-py.vercel.app/)
## Try locally
1. Clone the repository
2. Install [pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx)
3. Install [poetry](https://python-poetry.org/docs/)
4. Navigate to the project directory and install the dependencies
```bash
poetry install
```
5. Activate the virtual environment
```bash
poetry shell
```
6. Run the app
```bash
shiny run --reload signature/app.py
```
or shortcut:
```bash
poe runshiny
```
## Modify the theme
This app uses Bootstrap `5.3.3`.
To modify the theme, edit the `signature/scss/signature.scss` file.
To compile the SCSS to CSS, run:
```bash
cd signature
sass scss/signature.scss css/signature.css
```
## How the redirection banner works?
The redirection banner is a JavaScript function that redirects the user to the specified URL.
To modify the redirection URL, creeate a `index.html` file at the root of the project.
See : [signature](https://github.com/ThinkR-open/signature/)
## Mockup
The mockup was created using [Figma](https://www.figma.com/).
Explore the mockup [here](https://www.figma.com/proto/u95KvEqgWLB8arxt7saZcJ/%7Bsignature%7D?node-id=705-5&t=xevegkmzONTrRyR3-8&scaling=contain&content-scaling=fixed&page-id=0%3A1&starting-point-node-id=705%3A5&hide-ui=1).
## Deployment
The app is deployed on **Vercel**.
Export the signature site using the following command:
```bash
poetry shell
shinylive export signature site
```
Then update run the app locally using the following command:
```bash
python3 -m http.server --directory site --bind localhost 8008
```
## Tests
To run the tests, use the following command:
```bash
poetry run pytest
```
or
```bash
poetry run pytest --github-report --verbose
```
or shortcut:
```bash
poe test
```
If you are using VSCode, you can also dowload the 'Playwright Test' extension and run the tests from the testing tab.
[Playwright Test](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
## Poe commands
This project uses the `poe` command to run the app, tests, and other commands.
To see the available commands, run:
```bash
poe
```
All the commands are defined in the `pyproject.toml` file.
Create a new command by adding a new entry in the `tasks` section of the `pyproject.toml` file.
```toml
[tool.poe.tasks]
hello = "echo 'Hello, world!'"
```
## You love this project?
You love this project and would like to reuse it for your own needs?
You can fork this repository and adapt it to your needs.
What you can do:
- fork this repository
- adapt the signature template to your needs. The template is located in the `signature/template` folder. Edit the `template.html` file to modify the signature template.
- modify the app to add or remove fields from the signature form to edit the signature.
- update tests to match the new fields.
- modify the redirection banner to redirect to your own URL.
- modify the theme by editing the `signature/scss/signature.scss` file.
- Remove google analytics from tag script in the `app.py` file.
- deploy the app on your own server.
- share the app with your colleagues.
- enjoy the app!
## Code of Conduct
Please note that the signature.py project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.