{"id":18784496,"url":"https://github.com/pwittchen/pkup","last_synced_at":"2025-04-13T12:33:13.512Z","repository":{"id":53542213,"uuid":"77081680","full_name":"pwittchen/pkup","owner":"pwittchen","description":"semi-automated generating of PKUP report","archived":false,"fork":false,"pushed_at":"2021-03-25T11:19:40.000Z","size":38,"stargazers_count":5,"open_issues_count":3,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2023-08-13T12:11:38.166Z","etag":null,"topics":["diff","document","git","hybris","pkup","report","sap","word"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pwittchen.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}},"created_at":"2016-12-21T19:51:23.000Z","updated_at":"2023-07-18T05:43:36.000Z","dependencies_parsed_at":"2022-08-24T20:42:35.691Z","dependency_job_id":null,"html_url":"https://github.com/pwittchen/pkup","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwittchen%2Fpkup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwittchen%2Fpkup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwittchen%2Fpkup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwittchen%2Fpkup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pwittchen","download_url":"https://codeload.github.com/pwittchen/pkup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223588594,"owners_count":17169879,"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":["diff","document","git","hybris","pkup","report","sap","word"],"created_at":"2024-11-07T20:43:11.125Z","updated_at":"2024-11-07T20:43:12.713Z","avatar_url":"https://github.com/pwittchen.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"pkup [![Build Status](https://travis-ci.org/pwittchen/pkup.svg?branch=master)](https://travis-ci.org/pwittchen/pkup)\n====\nsemi-automated generating of PKUP report\n\nPKUP stands for *Podwyższone Koszty Uzyskania Przychodu* in Polish language. Every month every employee of my current company needs to generate PKUP report. It's legal issue, which allows to pay lower income taxes due to creative work. Preparing such report is boring \u0026 repeatable work, which can be automated. That's why this project was created. [Read more in the article on the blog](https://wittchen.io/posts/automate-boring-stuff/).\n\nRequirements\n------------\n- unix shell\n- python\n- pip\n\n### Satisfying requirements\n\n- **macOS**: `brew install python3`\n- **Ubuntu**: `sudo apt-get install python python-pip` (on other **Linux** distros simply use another package manager)\n- **MS Windows**: this solution wasn't tested on MS Windows, but it should work with [Python](https://www.python.org/downloads/) and [Cygwin](https://cygwin.com/install.html). Here's a good resource regarding this topic: https://www.davidbaumgold.com/tutorials/set-up-python-windows/. Free VMs with Windows for non-Windows users, who want to perform tests, can be downloaded here: https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/.\n\nInstallation\n------------\n\nAssuming you have `python`, `pip` and `git` installed, run the following commands:\n\n```shell\ngit clone https://github.com/pwittchen/pkup.git\ncd pkup\n./install.sh\n```\n\nThen, edit `~/.pkup.conf` file to personalize your future reports. Remember that pkup script also takes into consideration your user name in `.gitconfig` file and it should be in format: `Name Surname`.\n\nIf you have problem with installing dependencies via installation script, try to install them manually via `pip` in the following way:\n\n```\npip install -r requirements.txt\n```\n\nor\n\n```\npip install python-docx\n```\n\nIf it doesn't work, try to call `pip3` instead of `pip`.\n\nUsage\n-----\n\nParameters of the `pkup` script are as follows:\n\n```shell\n-h                             shows help\n-m \"\u003cmessage for the report\u003e\"  generates a report with a provided message\n-g                             generates a report with an empty message\n```\n\nexemplary usage of the script is as follows:\n\n```shell\npkup -m \"\u003cmessage with description of your work\u003e\"\n```\n\nThis command will generate `*.diff` files with changes made by user in defined repositories and appropriate report in `*.docx` file. Location of the reports and `*.diff` files is defined in `.pkup.conf` file and can be adjusted to user's needs.\n\nYou can also use script with `-g` parameter, which will generate report with an empty message and fill in the `*.docx` document later:\n\n```shell\npkup -g\n```\n\nTo show help, type:\n\n```shell\npkup -h\n```\n\nUpdate\n------\n\nTo update scripts, type:\n\n```shell\ncd pkup\ngit pull\n./install.sh\n```\n\nUninstallation\n--------------\n\nTo uninstall scripts, type:\n\n```shell\n./uninstall.sh\n```\n\nTests\n-----\n\nTo run python tests, type:\n\n```shell\n./pkup_doc_test.py\n```\n\n**Please note**: Tests are quite poor right now and require improvements.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpwittchen%2Fpkup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpwittchen%2Fpkup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpwittchen%2Fpkup/lists"}