{"id":16495662,"url":"https://github.com/bitranox/pct_python_default_test","last_synced_at":"2025-03-02T19:18:17.097Z","repository":{"id":41844864,"uuid":"280240073","full_name":"bitranox/pct_python_default_test","owner":"bitranox","description":"result of the PizzaCutter python default template","archived":false,"fork":false,"pushed_at":"2025-01-24T23:21:55.000Z","size":196,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-25T23:47:03.438Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/bitranox.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-07-16T19:26:16.000Z","updated_at":"2025-01-24T23:21:58.000Z","dependencies_parsed_at":"2024-01-20T02:36:15.204Z","dependency_job_id":"19451409-1a44-42d2-89b6-b02ae6e30554","html_url":"https://github.com/bitranox/pct_python_default_test","commit_stats":{"total_commits":124,"total_committers":2,"mean_commits":62.0,"dds":0.008064516129032251,"last_synced_commit":"a4404a9e4db21ee2c1a217b45b2678b2bf452cca"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitranox%2Fpct_python_default_test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitranox%2Fpct_python_default_test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitranox%2Fpct_python_default_test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitranox%2Fpct_python_default_test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitranox","download_url":"https://codeload.github.com/bitranox/pct_python_default_test/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241557166,"owners_count":19981881,"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-11T14:32:01.097Z","updated_at":"2025-03-02T19:18:17.069Z","avatar_url":"https://github.com/bitranox.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"pct_python_default_test\n=======================\n\n\nVersion v1.0.10 as of 2024-01-20 see `Changelog`_\n\n|build_badge| |codeql| |license| |jupyter|\n|black| |codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|\n\n\n\n.. |build_badge| image:: https://github.com/bitranox/pct_python_default_test/actions/workflows/python-package.yml/badge.svg\n   :target: https://github.com/bitranox/pct_python_default_test/actions/workflows/python-package.yml\n\n\n.. |codeql| image:: https://github.com/bitranox/pct_python_default_test/actions/workflows/codeql-analysis.yml/badge.svg?event=push\n   :target: https://github.com//bitranox/pct_python_default_test/actions/workflows/codeql-analysis.yml\n\n.. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg\n   :target: http://en.wikipedia.org/wiki/MIT_License\n\n.. |jupyter| image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/bitranox/pct_python_default_test/master?filepath=pct_python_default_test.ipynb\n\n.. for the pypi status link note the dashes, not the underscore !\n.. |pypi| image:: https://img.shields.io/pypi/status/pct-python-default-test?label=PyPI%20Package\n   :target: https://badge.fury.io/py/pct_python_default_test\n\n.. badge until 2023-10-08:\n.. https://img.shields.io/codecov/c/github/bitranox/pct_python_default_test\n.. badge from 2023-10-08:\n.. |codecov| image:: https://codecov.io/gh/bitranox/pct_python_default_test/graph/badge.svg\n   :target: https://codecov.io/gh/bitranox/pct_python_default_test\n\n.. |cc_maintain| image:: https://img.shields.io/codeclimate/maintainability-percentage/bitranox/pct_python_default_test?label=CC%20maintainability\n   :target: https://codeclimate.com/github/bitranox/pct_python_default_test/maintainability\n   :alt: Maintainability\n\n.. |cc_issues| image:: https://img.shields.io/codeclimate/issues/bitranox/pct_python_default_test?label=CC%20issues\n   :target: https://codeclimate.com/github/bitranox/pct_python_default_test/maintainability\n   :alt: Maintainability\n\n.. |cc_coverage| image:: https://img.shields.io/codeclimate/coverage/bitranox/pct_python_default_test?label=CC%20coverage\n   :target: https://codeclimate.com/github/bitranox/pct_python_default_test/test_coverage\n   :alt: Code Coverage\n\n.. |snyk| image:: https://snyk.io/test/github/bitranox/pct_python_default_test/badge.svg\n   :target: https://snyk.io/test/github/bitranox/pct_python_default_test\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/pct-python-default-test\n   :target: https://pypi.org/project/pct-python-default-test/\n   :alt: PyPI - Downloads\n\nThis is the test project created using PizzaCutter\n\nPizzaCutter is a command-line utility that creates and updates software projects in any language from PizzaCutter project templates.\n\nThe purpose of this repository is, to show and test a newly created project from the python default template.\n\n\nMore Information can be found here :\n    - `PizzaCutter \u003chttps://github.com/bitranox/PizzaCutter\u003e`_\n    - `PizzaCutter python default template \u003chttps://github.com/bitranox/pct_python_default\u003e`_\n    - more templates to come\n\n----\n\nautomated tests, Github Actions, Documentation, Badges, etc. are managed with `PizzaCutter \u003chttps://github\n.com/bitranox/PizzaCutter\u003e`_ (cookiecutter on steroids)\n\nPython version required: 3.8.0 or newer\n\ntested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10 - architectures: amd64\n\n`100% code coverage \u003chttps://codeclimate.com/github/bitranox/pct_python_default_test/test_coverage\u003e`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows \u003chttps://github.com/bitranox/pct_python_default_test/actions/workflows/python-package.yml\u003e`_, automatic daily builds and monitoring\n\n----\n\n- `Try it Online`_\n- `Usage`_\n- `Usage from Commandline`_\n- `Installation and Upgrade`_\n- `Requirements`_\n- `Acknowledgements`_\n- `Contribute`_\n- `Report Issues \u003chttps://github.com/bitranox/pct_python_default_test/blob/master/ISSUE_TEMPLATE.md\u003e`_\n- `Pull Request \u003chttps://github.com/bitranox/pct_python_default_test/blob/master/PULL_REQUEST_TEMPLATE.md\u003e`_\n- `Code of Conduct \u003chttps://github.com/bitranox/pct_python_default_test/blob/master/CODE_OF_CONDUCT.md\u003e`_\n- `License`_\n- `Changelog`_\n\n----\n\nTry it Online\n-------------\n\nYou might try it right away in Jupyter Notebook by using the \"launch binder\" badge, or click `here \u003chttps://mybinder.org/v2/gh/{{rst_include.\nrepository_slug}}/master?filepath=pct_python_default_test.ipynb\u003e`_\n\nUsage\n-----------\n\n- example for including docstrings\n\n.. code-block:: python\n\n    def main() -\u003e None:\n        \"\"\"\n        the main method, prints hello world\n\n\n        Parameter\n        ----------\n        none\n            none\n\n\n        Result\n        ----------\n        none\n\n\n        Exceptions\n        ----------\n        none\n\n\n        Examples\n        ----------\n\n        \u003e\u003e\u003e main()\n        Hello World - by PizzaCutter\n\n        \"\"\"\n\nUsage from Commandline\n------------------------\n\n.. code-block::\n\n   Usage: pct_python_default_test [OPTIONS] COMMAND [ARGS]...\n\n     a pizzacutter default test project, crated with PizzaCutter and the\n     PizzaCutter default python template\n\n   Options:\n     --version                     Show the version and exit.\n     --traceback / --no-traceback  return traceback information on cli\n     -h, --help                    Show this message and exit.\n\n   Commands:\n     info  get program informations\n\nInstallation and Upgrade\n------------------------\n\n- Before You start, its highly recommended to update pip and setup tools:\n\n\n.. code-block::\n\n    python -m pip --upgrade pip\n    python -m pip --upgrade setuptools\n\n\n\n\n- to install the latest version from github via pip:\n\n\n.. code-block::\n\n    python -m pip install --upgrade git+https://github.com/bitranox/pct_python_default_test.git\n\n\n- include it into Your requirements.txt:\n\n.. code-block::\n\n    # Insert following line in Your requirements.txt:\n    # for the latest development version :\n    pct_python_default_test @ git+https://github.com/bitranox/pct_python_default_test.git\n\n    # to install and upgrade all modules mentioned in requirements.txt:\n    python -m pip install --upgrade -r /\u003cpath\u003e/requirements.txt\n\n\n- to install the latest development version, including test dependencies from source code:\n\n.. code-block::\n\n    # cd ~\n    $ git clone https://github.com/bitranox/pct_python_default_test.git\n    $ cd pct_python_default_test\n    python -m pip install -e .[test]\n\n- via makefile:\n  makefiles are a very convenient way to install. Here we can do much more,\n  like installing virtual environments, clean caches and so on.\n\n.. code-block:: shell\n\n    # from Your shell's homedirectory:\n    $ git clone https://github.com/bitranox/pct_python_default_test.git\n    $ cd pct_python_default_test\n\n    # to run the tests:\n    $ make test\n\n    # to install the package\n    $ make install\n\n    # to clean the package\n    $ make clean\n\n    # uninstall the package\n    $ make uninstall\n\nRequirements\n------------\nfollowing modules will be automatically installed :\n\n.. code-block:: bash\n\n    ## Project Requirements\n    click\n    cli_exit_tools\n\nAcknowledgements\n----------------\n\n- special thanks to \"uncle bob\" Robert C. Martin, especially for his books on \"clean code\" and \"clean architecture\"\n\nContribute\n----------\n\nI would love for you to fork and send me pull request for this project.\n- `please Contribute \u003chttps://github.com/bitranox/pct_python_default_test/blob/master/CONTRIBUTING.md\u003e`_\n\nLicense\n-------\n\nThis software is licensed under the `MIT license \u003chttp://en.wikipedia.org/wiki/MIT_License\u003e`_\n\n---\n\nChangelog\n---------\n\n- new MAJOR version for incompatible API changes,\n- new MINOR version for added functionality in a backwards compatible manner\n- new PATCH version for backwards compatible bug fixes\n\nv1.0.10\n---------\n2024-01-20:\n    - add additional Environment Variables in Github Actions\n\nv1.0.9\n---------\n2024-01-11:\n    - add black 3.12 style\n    - set osx version to 3.12\n    - set windows version to 3.12\n\nv1.0.8\n---------\n2023-07-14:\n    - move 3rd_party_stubs directory to ``./.3rd_party_stubs``\n\nv1.0.7\n---------\n2023-07-14:\n    - add codeql badge\n    - move 3rd_party_stubs outside the src directory\n    - add pypy 3.10 tests\n    - add python 3.12-dev tests\n\nv1.0.6\n---------\n2023-07-13:\n    - require minimum python 3.8\n    - remove python 3.7 tests\n\nv1.0.5\n---------\n2023-xx-xx:\n    - introduce PEP517 packaging standard\n    - introduce pyproject.toml build-system\n    - remove mypy.ini\n    - remove pytest.ini\n    - remove setup.cfg\n    - remove setup.py\n    - remove .bettercodehub.yml\n    - remove .travis.yml\n    - update black config\n    - clean ./tests/test_cli.py\n\nv1.0.4\n---------\n2023-06-26:\n    - update black config\n    - remove travis config\n    - remove bettercodehub config\n    - do not upload .egg files to pypi.org\n\nv1.0.3\n---------\n2023-01-13:\n    - update github actions : checkout@v3 and setup-python@v4\n    - remove \"better code\" badges\n    - remove python 3.6 tests\n    - adding python 3.11 tests\n    - update pypy tests to 3.9\n\nv1.0.2\n--------\n2022-05-20: update github actions test matrix to python 3.10\n\nv1.0.1\n--------\n2022-03-29: remedy mypy Untyped decorator makes function \"cli_info\" untyped\n\nv1.0.0\n---------\n2022-03-25: remove listdir of ./dist, moved to lib_cicd_github\n\nv0.1.1\n---------\n2020-08-01: fix pypi deploy\n\nv0.1.0\n--------\n2020-07-31:\n    - change1\n    - change2\n    - ...\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitranox%2Fpct_python_default_test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitranox%2Fpct_python_default_test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitranox%2Fpct_python_default_test/lists"}