{"id":19250817,"url":"https://github.com/erik-ingwersen-ey/cookiepy","last_synced_at":"2025-08-02T13:37:14.130Z","repository":{"id":46320447,"uuid":"515278968","full_name":"erik-ingwersen-ey/cookiepy","owner":"erik-ingwersen-ey","description":"Cookiecutter para criação de novos pacotes Python, do acelerador EY DDA.","archived":false,"fork":false,"pushed_at":"2025-07-28T14:05:19.000Z","size":3439,"stargazers_count":0,"open_issues_count":25,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-28T16:08:35.530Z","etag":null,"topics":["acelerador-ey-dda","cookiecutter-python"],"latest_commit_sha":null,"homepage":"https://ingwersen-erik.github.io/cookiepy/docs/intro","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/erik-ingwersen-ey.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.rst","code_of_conduct":"CODE_OF_CONDUCT.rst","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,"zenodo":null}},"created_at":"2022-07-18T17:26:16.000Z","updated_at":"2024-05-16T11:26:10.000Z","dependencies_parsed_at":"2023-02-15T11:47:09.484Z","dependency_job_id":"467aab9d-6f45-44f0-9a85-7f27f73aee8b","html_url":"https://github.com/erik-ingwersen-ey/cookiepy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/erik-ingwersen-ey/cookiepy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erik-ingwersen-ey%2Fcookiepy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erik-ingwersen-ey%2Fcookiepy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erik-ingwersen-ey%2Fcookiepy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erik-ingwersen-ey%2Fcookiepy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/erik-ingwersen-ey","download_url":"https://codeload.github.com/erik-ingwersen-ey/cookiepy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erik-ingwersen-ey%2Fcookiepy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268400233,"owners_count":24244443,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["acelerador-ey-dda","cookiecutter-python"],"created_at":"2024-11-09T18:18:46.903Z","updated_at":"2025-08-02T13:37:14.085Z","avatar_url":"https://github.com/erik-ingwersen-ey.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. Logo EY\n\n.. raw:: html\n\n   \u003cp align=\"center\"\u003e\u003cimg align=\"left\" style=\"object-fit: none; object-position: -120px 120px; width: 100px; height: 120px\" src=\"./docs/_static/EY_logo_1.gif\" alt=\"EY Logo\"\u003e\u003c/p\u003e\u003cbr\u003e\u003ch1\u003e  cookiepy\u003c/h1\u003e\u003cbr\u003e\n\n.. badges-begin\n\n| |Status| |Python Version| |License| |Read the Docs| |Codecov|\n| |pre-commit| |Black| |Contributor Covenant|\n\n.. |Status| image:: https://badgen.net/badge/status/alpha/d8624d\n   :target: https://badgen.net/badge/status/alpha/d8624d\n   :alt: Project Status\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/cookiepy-instance\n   :target: https://github.com/ingwersen-erik/cookiepy\n   :alt: Python Version\n.. |License| image:: https://img.shields.io/github/license/ingwersen-erik/cookiepy\n   :target: https://opensource.org/licenses/MIT\n   :alt: License\n.. |Read the Docs| image:: https://img.shields.io/readthedocs/cookiepy/latest.svg?label=Read%20the%20Docs\n   :target: https://cookiepy.readthedocs.io/\n   :alt: Read the documentation at https://cookiepy.readthedocs.io/\n.. |Codecov| image:: https://codecov.io/gh/ingwersen-erik/cookiepy-instance/branch/main/graph/badge.svg\n   :target: https://codecov.io/gh/ingwersen-erik/cookiepy-instance\n   :alt: Codecov\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :target: https://github.com/pre-commit/pre-commit\n   :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n   :alt: Black\n.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\n   :target: https://github.com/ingwersen-erik/cookiepy/blob/main/CODE_OF_CONDUCT.rst\n   :alt: Contributor Covenant\n\n.. badges-end\n\n.. raw:: html\n\n   \u003cbr\u003e\n\n.. Project authors:\n.. _Erik Ingwersen: https://github.com/ingwersen-erik\n\n.. Project Wiki:\n.. _EY DDA: https://www.ey.com/en_gl/big-data-analytics\n\n.. bibliographic fields:\n\n:Author: `Erik Ingwersen`_\n:Contact: erik.ingwersen@br.ey.com\n:organization: `EY DDA`_\n:date: 2022-09-09 (Thu, 09 Sep 2022)\n:status: Pre-Alpha\n:version: 0.1.0\n:copyright: Copyright (c) EY Brazil, Inc. and its affiliates. All Rights Reserved.\n\n.. meta::\n   :keywords: Cookiecutter, cookiepy, Acelerador DDA\n   :description lang=pt: Readme do pacote cookiepy.\n\n:abstract:\n    Cookiecutter para o Acelerador de projetos EY DDA.\n\n-----\n\nDescrição\n=========\n\nCookiecutter para automação da criação de repositório Python para projetos.\n\n**:warning: Importante:** Esta ferramenta assume que você tenha um conhecimento\nprévio de como criar pacotes em Python e, como usar ferramentas de\nversionamento de código (GitHub, Bitbucket, Gitlab, etc.).\n\n\nDocumentação do Projeto\n=======================\n\n✨📚✨ `Link para documentação`__\n\n__ https://cookiepy.readthedocs.io/\n\n-----\n\nQuickstart\n----------\n\nO ``cookiepy`` requer instalação prévia do pacote `cookiecutter \u003chttps://cookiecutter.readthedocs.io/en/latest/\u003e`_.\nExecute o seguinte comando para instalar o ``cookiecutter``:\n\n.. code-block:: console\n\n    $ pip install cookiecutter\n\n\n**:bulb: Observação:** caso você não consiga executar o comando acima,\ntente executar novamente,\nincluindo a opçao ``-U``, ou ``--user``:\n\n.. code-block:: console\n\n    $ pip install -U cookiecutter\n    # Mesmo que:\n    $ pip install --user cookiecutter\n\nAlguns sistemas operacionais restringem a instalação de certos pacotes.\nA opção ``--user`` força a instalação do pacote somente para o seu usuário.\nEm geral, aplicações que são instaladas dentro do diretório de usuário requerem\num nível menor de permissões. Muitas vezes, erros de falta de permissão são\nsolucionados, quando você realiza a instalação de aplicações a nível de usuário,\nao invés de global. Esse tipo de bloqueio ocorre com bastante frequência no Windows,\nespecialmente em ambientes corporativos.\n\nCom o `cookiecutter \u003chttps://cookiecutter.readthedocs.io/en/latest/\u003e`_ instalado,\nbasta executar o seguinte comando:\n\n.. code-block:: console\n\n   $ cookiecutter gh:ingwersen-erik/cookiepy\n\n\nExemplo de Uso do ``cookiepy``\n------------------------------\n\nO vídeo abaixo mostra o processo de criação de um novo projeto, utilizando o ``cookiepy``:\n\n.. raw:: html\n\n   \u003cp align=\"center\"\u003e\u003cimg src=\"./docs/_static/demo-acelerador-dda.gif\" alt=\"Demo\"/\u003e\u003c/p\u003e\n   \u003cbr\u003e\n\n\nFuncionalidades\n===============\n\nO pacote gerado pelo ``cookiepy`` possui as seguintes funcionalidades pré-configuradas:\n\n.. features-begin\n\n- Gerenciamento e empacotamento de pacotes, usando Poetry_\n- Automação de testes unitários, usando Nox_\n- Avaliação de qualidade do seu código durante o commit_, usando Flake8_\n- Serviços de CI/CD, com ações pré-configuradas, usando `GitHub Actions`_\n- Automação do processo de geração de documentação do seu código-fonte usando `Sphinx`_, MyST_, e `Read the Docs`_\n- Criação automática de change-logs, usando `Release Drafter`_\n- Atualização automática de dependências com Dependabot_\n- Formatação do código usando `Black`_ e Prettier_\n- Ordenação e validação de imports dos módulos do seu código, com o isort_\n- Relatório de cobertura de código (coverage), usando Codecov_\n- Análise estática e type-hints com mypy_\n- Análise dinâmica de type-hints, com Typeguard_\n- Mudanças de sintaxe, de acordo com a versão do Python configurada pelo usuário, usando pyupgrade_\n- Análise estática de segurança com Bandit_ e Safety_\n- Validação de exemplos de código escritos na documentação com xdoctest_\n- Gerenciamento de labels de repositório com `GitHub Labeler`_\n\n\n**Esta ferramenta foi testada nas seguintes versões do Python:** Python 3.7, 3.8, 3.9, e 3.10.\n\n.. features-end\n\n.. references-begin\n\n.. _Bandit: https://github.com/PyCQA/bandit\n.. _Black: https://github.com/psf/black\n.. _Click: https://click.palletsprojects.com/\n.. _Codecov: https://codecov.io/\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _Coverage.py: https://coverage.readthedocs.io/\n.. _Dependabot: https://dependabot.com/\n.. _Flake8: http://flake8.pycqa.org\n.. _GitHub Actions: https://github.com/features/actions\n.. _Hypermodern Python: https://medium.com/@ingwersen-erik/hypermodern-python-d44485d9d769\n.. _isort: https://pycqa.github.io/isort/\n.. _MyST: https://myst-parser.readthedocs.io/\n.. _Nox: https://nox.thea.codes/\n.. _Poetry: https://python-poetry.org/\n.. _Prettier: https://prettier.io/\n.. _PyPI: https://pypi.org/\n.. _Read the Docs: https://readthedocs.org/\n.. _Release Drafter: https://github.com/release-drafter/release-drafter\n.. _Safety: https://github.com/pyupio/safety\n.. _Sphinx: http://www.sphinx-doc.org/\n.. _TestPyPI: https://test.pypi.org/\n.. _Typeguard: https://github.com/agronholm/typeguard\n.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html\n.. _furo: https://pradyunsg.me/furo/\n.. _mypy: http://mypy-lang.org/\n.. _napoleon: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html\n.. _pre-commit: https://pre-commit.com/\n.. _pytest: https://docs.pytest.org/en/latest/\n.. _pyupgrade: https://github.com/asottile/pyupgrade\n.. _sphinx-click: https://sphinx-click.readthedocs.io/\n.. _xdoctest: https://github.com/Erotemic/xdoctest\n.. _GitHub Labeler: https://github.com/marketplace/actions/github-labeler\n\n.. references-end\n\n\n----\n\nInformações Adicionais\n======================\n\n\nEstrutura do repositório\n------------------------\n\nO ``cookiepy`` possui a seguinte estrutura de pastas:\n\n.. code-block:: text\n\n    cookiepy\n    ├── CODE_OF_CONDUCT.rst             \u003c- Código de conduta (copiado de outros templates).\n    ├── CONTRIBUTING.rst                \u003c- Guia de contribuição. Está em inglês.\n    ├── LICENSE.rst                     \u003c- Licença do projeto (por enquanto está como MIT)\n    ├── README.rst                      \u003c- Este arquivo que você está lendo.\n    ├── cookiecutter.json               \u003c- Arquivo com os parâmetros utilizado pelo cookiepy para gerar novos repositórios\n    ├── docs                            \u003c- Diretório com a documentação da ferramenta.\n    ├── noxfile.py                      \u003c- Arquivo nox com as configurações de testes unitários.\n    ├── pycharm.sh                      \u003c- Comando Mac/Linux para inicialização do PyCharm (se instalado).\n    ├── pyproject.toml                  \u003c- Arquivos com as configurações e dependencias da ferramenta.\n    ├── tools                           \u003c- scripts para automação CI/CD.\n    │   ├── dependencies_table.py       \u003c- Script analisa os scripts Python do projeto e gera uma tabela de dependências.\n    │   ├── prepare_github_release.py   \u003c- Script de preparação de novas releases.\n    │   └── publish_github_release.py   \u003c- Script de publicação de releases em repositório do GitHub.\n    ├── hooks                           \u003c- Diretório com os arquivos utilizados para criação do repositório.\n    │   ├── post_gen_project.py         \u003c- Script executado após a geração do repositório.\n    │   └── pre_gen_project.py          \u003c- Script executado antes da geração do repositório.\n    └── {{cookiecutter.project_name}}   \u003c- Template do pacote que será criado.\n\n\nTO-DO :construction: \n--------------------\n\n- [ ] Traduzir o template para português :brazil:.\n  Inicialmente, a minha ideia era criar o cookiecutter em inglês,\n  já que a maioria das empresas preferem que o código seja escrito em inglês.\n- [ ] Melhorar os tutoriais de como instalar/usar o ``cookiepy``. :basecamp:\n- [ ] Adicionar tutoriais, com melhores práticas, dicas e casos-de-uso da ferramenta. :bulb:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferik-ingwersen-ey%2Fcookiepy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferik-ingwersen-ey%2Fcookiepy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferik-ingwersen-ey%2Fcookiepy/lists"}