{"id":17345088,"url":"https://github.com/sveetch/cookiecutter-sveetch-python","last_synced_at":"2025-07-29T09:38:09.317Z","repository":{"id":145735021,"uuid":"274012402","full_name":"sveetch/cookiecutter-sveetch-python","owner":"sveetch","description":"Yet another Cookiecutter template to produce a repository to start a Python3 package.","archived":false,"fork":false,"pushed_at":"2023-10-15T16:43:10.000Z","size":92,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-01T15:11:44.147Z","etag":null,"topics":["cookiecutter","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sveetch.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-06-22T01:24:46.000Z","updated_at":"2023-09-13T14:37:12.000Z","dependencies_parsed_at":"2023-03-28T00:20:57.549Z","dependency_job_id":null,"html_url":"https://github.com/sveetch/cookiecutter-sveetch-python","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveetch%2Fcookiecutter-sveetch-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveetch%2Fcookiecutter-sveetch-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveetch%2Fcookiecutter-sveetch-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveetch%2Fcookiecutter-sveetch-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sveetch","download_url":"https://codeload.github.com/sveetch/cookiecutter-sveetch-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245823495,"owners_count":20678196,"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":["cookiecutter","python"],"created_at":"2024-10-15T16:29:18.230Z","updated_at":"2025-07-29T09:38:09.304Z","avatar_url":"https://github.com/sveetch.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _Python: https://www.python.org\n.. _virtualenv: https://virtualenv.pypa.io\n.. _pip: https://pip.pypa.io\n.. _Pytest: http://pytest.org\n.. _Napoleon: https://sphinxcontrib-napoleon.readthedocs.org\n.. _Flake8: http://flake8.readthedocs.org\n.. _Sphinx: http://www.sphinx-doc.org\n.. _tox: http://tox.readthedocs.io\n.. _livereload: https://livereload.readthedocs.io\n.. _Click: https://click.palletsprojects.com\n.. _Read the Docs: https://readthedocs.org/\n.. _Furo: https://github.com/pradyunsg/furo\n.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html\n.. _twine: https://twine.readthedocs.io\n\n===========================\ncookiecutter-sveetch-python\n===========================\n\nYet another `Cookiecutter`_ template to produce a repository to start\na Python package.\n\nIt emphases on a simple application with quality and not any relation to\nany service (state badge, pyup, travis, etc..) except\n`Read the Docs service \u003chttps://readthedocs.org/\u003e`_ for documentation publishing.\n\nA sample built from this template is available on repository\n`sveetch-python-sample \u003chttps://github.com/sveetch/sveetch-python-sample\u003e`_.\n\n\nFeatures\n********\n\nOnce created a project will have everything to start:\n\n* Development in a Python virtual environment with `virtualenv`_ and `pip`_;\n* Promote Test Driven Development with `Pytest`_;\n* Configuration in ``setup.cfg`` ready to upload package to Pypi;\n* Sample object to say hello world;\n* Optional CLI sample with `Click`_;\n* Optional GIT repository initialization;\n* `Flake8`_ configuration for quality review;\n* Tests on sample object;\n* `tox`_ configuration for tests;\n* Code is fully documented with `reStructuredText`_ and `Napoleon`_ extension for\n  `Sphinx`_ with modern theme `Furo`_.\n* Release with `twine`_.\n\nPackage cover some basic features:\n\n* Object inheritance;\n* Basic CLI features;\n* Python logging usage;\n* Testing core, command line and logging;\n\n\nUsage\n*****\n\nWithout installation\n--------------------\n\nBasically to use this cookie to create a new project you just need to install\n`Cookiecutter`_ version 2.4.0 or latter: ::\n\n    pip install cookiecutter\u003e=2.4.0\n\nYou may then use it from its repository URL: ::\n\n    cookiecutter https://github.com/sveetch/cookiecutter-sveetch-python.git\n\n\nWith local installation\n------------------------\n\nTo speed up project creation you may install this cookie on your system.\n\nFirst ensure you have `pip`_ and `virtualenv`_ packages installed and *GNU make*\navailable on your system. Then type: ::\n\n    git clone https://github.com/sveetch/cookiecutter-sveetch-python.git\n    cd cookiecutter-sveetch-python\n    make install\n\n.. Warning::\n\n    You will need to update your install yourself opposed to the direct\n    repository usage (*without install*) which always try to use the latest version\n    from master branch.\n\n    We recommend to reset it and reinstall it again: ::\n\n        git pull origin master\n        make clean install\n\nMakefile task\n.............\n\nYou can use the included Makefile task: ::\n\n    make project\n\nIt will create all new project in ``dist/`` directory.\n\n\nBash alias\n..........\n\nOnce installed you can also create shortcut with a bash alias in\nyour ``.bash_aliases``: ::\n\n    alias cookpy='/home/foo/cookiecutter-sveetch-python/.venv/bin/cookiecutter /home/foo/cookiecutter-sveetch-python'\n\nSo you will just have to execute following command to create a new project: ::\n\n    cookpy\n\n\nOptions\n-------\n\nYou can define author full name, email, github username, pypi username,\nversion start, package name and package short description.\n\nSome of these have a default value filled from a previous value, obviously\nyou can edit it to your own needs.\n\nYou can pre define some options in your\n`cookiecutter user configuration \u003chttps://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html\u003e`_\nto avoid some inputs. This is especially recommended for options related to author that\nyou should probably always use the same.\n\n\nNaming\n******\n\nFor a given ``Sample bar`` project name:\n\n* Package name will be ``sample-bar``;\n* Application name will ``sample_bar``;\n\nYou can change package and application names during project creation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsveetch%2Fcookiecutter-sveetch-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsveetch%2Fcookiecutter-sveetch-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsveetch%2Fcookiecutter-sveetch-python/lists"}