{"id":18423303,"url":"https://github.com/xmodar/python-package","last_synced_at":"2025-04-13T14:44:51.618Z","repository":{"id":111509475,"uuid":"165939833","full_name":"xmodar/python-package","owner":"xmodar","description":"A minimal Python package for a CLI app with automated unit tests and continuous integration bundled using poetry","archived":false,"fork":false,"pushed_at":"2019-02-06T12:50:11.000Z","size":327,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-16T07:41:33.982Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/xmodar.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-15T23:32:06.000Z","updated_at":"2021-12-06T10:47:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c999972-8140-44c1-8b18-c076220f0900","html_url":"https://github.com/xmodar/python-package","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/xmodar%2Fpython-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xmodar%2Fpython-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xmodar%2Fpython-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xmodar%2Fpython-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xmodar","download_url":"https://codeload.github.com/xmodar/python-package/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732219,"owners_count":21152841,"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-11-06T04:36:44.443Z","updated_at":"2025-04-13T14:44:51.583Z","avatar_url":"https://github.com/xmodar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Package\n\n[![Last Commit](https://img.shields.io/github/last-commit/ModarTensai/python-package.svg)](https://github.com/ModarTensai/python-package/commits/master)\n[![Repository Size](https://img.shields.io/github/repo-size/ModarTensai/python-package.svg)](https://github.com/ModarTensai/python-package/archive/master.zip)\n[![Build Status](https://travis-ci.com/ModarTensai/python-package.svg?token=nsBux3TDRWWpFxuY8dgp\u0026branch=master)](https://travis-ci.com/ModarTensai/python-package)\n[![Total Downloads](https://img.shields.io/github/downloads/ModarTensai/python-package/total.svg)](https://github.com/ModarTensai/python-package/archive/master.zip)\n[![License](https://img.shields.io/github/license/ModarTensai/python-package.svg)](https://github.com/ModarTensai/python-package/blob/master/LICENSE)\n\n\nThis is a minimal python package for a CLI app with automated unit tests and continuous integration bundled using [poetry](https://poetry.eustace.io/).\n\nThis project can take a lot of inspirations from [pendulum](https://github.com/sdispater/pendulum), which is made by the developer of poetry.\n\n## Features\n\n - It has a [LICENSE](./LICENSE) file\n - It has a [README.md](./README.md) file\n - It is bundled using [poetry](https://poetry.eustace.io/)\n - [mkdocs](https://www.mkdocs.org/) documentation published using [GitHub pages](https://pages.github.com/) on a [custom domain](https://python-package.modar.me)\n - Shipped with a [VS Code](https://code.visualstudio.com/)'s workspace [file](./vs.code-workspace) and recommended [extensions](./.vscode/extensions.json)\n    - Configured for python linting with [pep8](https://pypi.org/project/pep8/), [pylint](https://www.pylint.org/), [mypy](http://mypy-lang.org/) and [pydocstyle](http://www.pydocstyle.org/en/3.0.0/usage.html)\n    - Enables auto-formating with Google style using [yapf](https://github.com/google/yapf) and [isort](https://pypi.org/project/isort/)\n - An example package of an English dictionary with the following:\n    - Follows the guidelines specified by the mentioned linters\n    - Type hints and annotations with [mypy](http://mypy-lang.org/)\n    - Uses [pathlib](https://docs.python.org/3/library/pathlib.html), [logging](https://realpython.com/python-logging/) and [click](https://click.palletsprojects.com/en/7.x/)\n    - Unit tested using [pytest](https://pytest.org) ([TODO] trying [pytest-mock](https://pypi.org/project/pytest-mock/))\n - Automated testing using [tox](https://tox.readthedocs.io/en/latest/) and stats using [pytest-cov](https://pytest-cov.readthedocs.io/en/latest/)\n - Continuous integration (CI) using [Travis-CI](https://travis-ci.com/) and GitHub badges using [shields](https://shields.io/)\n - [TODO] publish on [PyPI](https://pypi.org/) (and maybe [conda](https://conda.io))\n - [TODO] Makefile and VS Code tasks\n - [TODO] use [docker](https://www.docker.com/) and [kubernetes](https://kubernetes.io/)\n - [TODO] create a [cookiecutter](https://github.com/audreyr/cookiecutter)\n\n\n## Requirements\n\nThe assumed operating system is Ubuntu and follow the [documentation](https://python-package.modar.me/requirements/):\n\n - [Install Python 3.7](https://python-package.modar.me/requirements/#installing-python-37-on-ubuntu-optional) (optional)\n - [Create a virtual environment](https://python-package.modar.me/requirements/#create-a-python-virtual-environment-on-ubuntu)\n - [Install JupyterLab](https://python-package.modar.me/requirements/#installing-jupyterlab-optional) (optional)\n - [Install Poetry](https://python-package.modar.me/requirements/#installing-poetry)\n\n## Usage\n\nWe recommend using [VS Code](https://code.visualstudio.com/) and following the instructions provided [here](https://python-package.modar.me/usage/).\n\n- [Documentation and GitHub Pages hosting](https://python-package.modar.me/usage/#documentation)\n- [Command Line Interface (CLI)](https://python-package.modar.me/usage/#command-line-interface-cli)\n- [Linting and testing](https://python-package.modar.me/usage/#linting-and-testing)\n\n## License\n\n[MIT](./LICENSE)\n\n## Author\n\n[Modar M. Alfadly](https://modar.me)\n\n## Contributors\n\nI would gladly accept any pull request to this repository.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxmodar%2Fpython-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxmodar%2Fpython-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxmodar%2Fpython-package/lists"}