{"id":16974626,"url":"https://github.com/alttiri/py-hello-world","last_synced_at":"2025-03-21T20:42:33.618Z","repository":{"id":53516597,"uuid":"521456458","full_name":"AlttiRi/py-hello-world","owner":"AlttiRi","description":"A simple example of an installable Python command line application","archived":false,"fork":false,"pushed_at":"2022-09-03T13:43:36.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-26T15:24:27.267Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlttiRi.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":"2022-08-05T00:40:31.000Z","updated_at":"2022-08-07T03:55:05.000Z","dependencies_parsed_at":"2023-01-17T18:55:11.332Z","dependency_job_id":null,"html_url":"https://github.com/AlttiRi/py-hello-world","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlttiRi%2Fpy-hello-world","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlttiRi%2Fpy-hello-world/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlttiRi%2Fpy-hello-world/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlttiRi%2Fpy-hello-world/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlttiRi","download_url":"https://codeload.github.com/AlttiRi/py-hello-world/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244868031,"owners_count":20523581,"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":[],"created_at":"2024-10-14T01:07:20.265Z","updated_at":"2025-03-21T20:42:33.602Z","avatar_url":"https://github.com/AlttiRi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# py-hello-world\n\nIt's a simple hello world example of an **_installable_** command line Python application.\n\nYou can install it and run in console some commands (`py-hello-world`, `py-hello-world-i`, `py-hello-world-sub`).\n\nAlso, it has optional command line argument `-t`/`--trace`. \nWith it the program logs package's and function's calls.\nIt almost makes no sense, but it's only just an example usage of command line arguments.\n\nAlso, it uses [termcolor](https://pypi.org/project/termcolor/) as a dependency to make this example more practical. \nThis external lib just makes the console output colored.\n\n---\n\n### Installation\n\n_Note: [Python](https://www.python.org/downloads/) installed is required. Don't forget to check \"Add to PATH\" while installing._\n\n```bash\npip install https://github.com/AlttiRi/py-hello-world/archive/master.tar.gz\n```\n\n_Or_, if you have also [Git](https://git-scm.com/downloads) installed:\n\n```bash\npip install git+https://github.com/AlttiRi/py-hello-world.git\n```\n\n### Dev Installation (from GH)\n```bash\ngit clone https://github.com/AlttiRi/py-hello-world.git\ncd py-hello-world\npython setup.py develop\n```\n\n### Dev Installation (local)\n```bash\npython setup.py develop\n```\n\nOr, the alternative command with the less verbose output:\n```bash\npip install --editable .\n```\n`-e`, `--editable` for [\"editable\"](https://pip.pypa.io/en/latest/topics/local-project-installs/#editable-installs) installing.\n\n---\n\n### Scripts\n\nAfter installing, you can run the follow scripts in a console in any place.\n\n```bash\npy-hello-world\n```\n```bash\npy-hello-world-wi\n```\n```bash\npy-hello-world-sub\n```\n\nThe same, but with `-t`, `--trace` command line argument:\n```bash\npy-hello-world -t\n```\n```bash\npy-hello-world-wi --trace\n```\n```bash\npy-hello-world-sub --trace\n```\n\nAlso, it has `-h`, `--help` and `--version`:\n\n```bash\npy-hello-world -h\n```\n```bash\npy-hello-world --help\n```\n```bash\npy-hello-world --version\n```\n\nWorking with command line arguments is implemented using the [argparse](https://docs.python.org/3/library/argparse.html) module.\n\n---\n\n### UnInstallation\n```bash\npip uninstall py-hello-world -y\n```\n\nWith dependencies:\n```bash\npip uninstall py-hello-world termcolor -y\n```\n\n---\n\n### Dependencies\n\n- [termcolor](https://pypi.org/project/termcolor/)\n\nManual installing:\n```bash\npip install termcolor\n```\n\nUninstalling:\n```bash\npip uninstall termcolor -y\n```\n\n---\n\n### Updating\n\nUsually just use the same command as for installing.\n\nTo install a updated version (with changes in the repo's code), but _which still has not updated version number_, \nuse [`--ignore-installed`](https://pip.pypa.io/en/latest/cli/pip_install/#options).\nFor example:\n```bash\npip install --ignore-installed --no-deps https://github.com/AlttiRi/py-hello-world/archive/master.tar.gz\n```\n`--no-deps` in this case is recommended in order to do not re-install the dependecies.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falttiri%2Fpy-hello-world","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falttiri%2Fpy-hello-world","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falttiri%2Fpy-hello-world/lists"}