{"id":22940715,"url":"https://github.com/devjoseruiz/signature","last_synced_at":"2025-04-01T20:36:27.317Z","repository":{"id":204168835,"uuid":"437392029","full_name":"devjoseruiz/signature","owner":"devjoseruiz","description":"Simple tool for updating bunches of email signatures.","archived":false,"fork":false,"pushed_at":"2021-12-11T21:25:34.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-14T13:31:22.926Z","etag":null,"topics":["email-template","html","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devjoseruiz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-12-11T21:25:24.000Z","updated_at":"2024-12-01T16:02:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"15399f38-f088-4d6d-9b3d-d82883c3ced8","html_url":"https://github.com/devjoseruiz/signature","commit_stats":null,"previous_names":["devjoseruiz/signature"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjoseruiz%2Fsignature","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjoseruiz%2Fsignature/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjoseruiz%2Fsignature/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjoseruiz%2Fsignature/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devjoseruiz","download_url":"https://codeload.github.com/devjoseruiz/signature/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237652130,"owners_count":19344828,"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":["email-template","html","python"],"created_at":"2024-12-14T13:30:27.741Z","updated_at":"2025-02-07T13:24:26.186Z","avatar_url":"https://github.com/devjoseruiz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Signature\n\nSignature, a tool for updating bunches of email signatures\n\n## Description\n\nThis project arises from the need to update the email signatures of a large batch of user accounts. Since it is totally inefficient to ask a person to manually update all accounts, the aim is to automate the task by offering an efficient and unattended solution.\n\nThis program has been developed thinking of two possible scenarios:\n\n- The utility runs in a server environment, in text mode, being called by another application or functioning as a service.\n\n- The utility is run in a desktop environment, in graphical mode, by a human operator.\n\nTo cover both cases, the tool has been provided with a command interpreter, as well as a wrapper, an independent graphical application that calls the main program, passing the parameters obtained by the graphical application.\n\n## Getting Started\n\n### Requirements\n\n- Python \u003e= 3.7.x\n- pip\n- Python venv\n\n### Installation\n\nFirst, go to the project folder and create a virtual environment:\n\n```bash\ncd project_folder\n```\n\n#### Linux\n\n```bash\npython3 -m venv env\n```\n\nThen activate the virtual environment:\n\n```bash\nsource env/bin/activate\n```\n\nUpgrade pip:\n\n```bash\npython3 -m pip install --upgrade pip\n```\n\nInstall the project dependencies with pip:\n\n```bash\npip install -r requirements.txt\n```\n\n#### Windows\n```powershell\npython -m venv env\n```\n\nIf you are using PowerShell you need to change the execution policy:\n\n```powershell\nSet-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser\n```\n\nThen activate the virtual environment:\n\n```powershell\nenv\\Scripts\\activate\n```\n\nUpgrade pip:\n\n```powershell\npython -m pip install --upgrade pip\n```\n\nInstall the project dependencies with pip:\n\n```powershell\npip install -r requirements.txt\n```\n\n### How to customize signature info\n\nThere are four variables you should care about. In the HTML template, you can include it by this way:\n\n- The user's full name: $full_name.\n- The user's email address: $email.\n- The user's phone number: $telephone.\n- The user's job title: $job_title.\n\nIt's mandatory to keep the \"$\" symbol at the beginning of the string.\n\n### How to generate an executable file\n\nSimply go to \"signature\" folder and run:\n\n```bash\npyinstaller --onefile main.py --name signature\n```\n\nThis will create an executable inside the \"dist\" folder.\n\n### How to run it\n\nFirstly, add the program to the system path.\n\n#### Linux\n\nMove the executable file to /usr/bin/:\n\n```bash\nmv signature /usr/bin/\n```\n\n#### Windows\n\nFor security, save a copy of the current path:\n\n```powershell\n$env:path \u003e\u003e path.out\n```\n\nNow, add a new entry to the path:\n\n```powershell\nsetx PATH \"$env:path;\\signature\\installation\\folder\" -m\n```\n\nFinally, restart the computer.\n\nNow you can run the program. For help about command options, simply run:\n\n```bash\nsignature --help\n```\n\nYou have to provide as arguments the paths of the following files:\n\n- A JSON file containing the Google workspace credentials.\n- An HTML file containing the signature template.\n- An ODS file (Google Sheets) containing the users' information.\n\n### How to generate a GUI wrapper\n\nSimply go to \"gui\" folder and run:\n\n```bash\npyinstaller --onefile main.py --name signature-gui\n```\n\nThis will create an executable inside the \"dist\" folder.\n\n### How to run the GUI application\n\nSimply run the executable file.\n\n## Authors\n\n- José Ruiz (joseruiz@keemail.me)\n\n## Contributing\n\nAny help is always welcomed. Just send PR or contact me.\n\n## License\n\nLicensed under GPLv3.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjoseruiz%2Fsignature","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevjoseruiz%2Fsignature","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjoseruiz%2Fsignature/lists"}