Package: cookiecutter-dinkin-flicka
Dinkin Flickaa versatile cookiecutter template for python projectsInstallationInstallcookiecutter:pipinstallcookiecutterGenerate a Python package structure usingcookiecutter-dinkin-flicka:cookiecutterhttps://github.com/luizdesuo/cookiecutter-dinkin-flicka.gitUsageEnter the settings:project_namefriendly_namepackage_short_descriptionpython_versionpackage_versioncopyright_yearauthoremailgithub_userlicenseMITApache License 2.0GNU General Public License v3.0BSD 3-ClauseProprietaryNonedevelopment_statusDevelopment Status :: 1 - PlanningDevelopment Status :: 2 - Pre-AlphaDevelopment Status :: 3 - AlphaDevelopment Status :: 4 - BetaDevelopment Status :: 5 - Production/StableDevelopment Status :: 6 - MatureDevelopment Status :: 7 - InactiveNonedata_version_control: includedvc,pandas,pyjanitorandpanderafalsetruedefensive_programming: includeicontract,hypothesis,icontract-hypothesisfalsetrueeepublish: includepypiandtestpypipublishing into github workflow
in addition toreadthedocsmentions into documentationfalsetrueThe project structure will look similar to that shown below:project-name
    ├── bandit.yml
    ├── codecov.yml
    ├── CODE_OF_CONDUCT.md
    ├── CONTRIBUTING.md
    ├── .cookiecutter.json
    ├── .darglint
    ├── docs
    │   ├── codeofconduct.md
    │   ├── conf.py
    │   ├── contributing.md
    │   ├── index.md
    │   ├── license.md
    │   ├── requirements.txt
    │   └── usage.md
    ├── .editorconfig
    ├── .flake8
    ├── .gitattributes
    ├── .github
    │   ├── dependabot.yml
    │   └── workflows
    │       └── release.yml
    ├── .gitignore
    ├── LICENSE
    ├── noxfile.py
    ├── .pre-commit-config.yaml
    ├── pyproject.toml
    ├── README.md
    ├── .readthedocs.yml
    ├── src
    │   └── project_name
    │       ├── __init__.py
    │       ├── __main__.py
    │       ├── project_name.py
    │       └── py.typed
    └── tests
        ├── __init__.py
        ├── test_main.py
        └── test_project_name.pyAfter changing directory to project-name folder, install the project with:poetryinstallStart version control tracking:gitinit
gitadd.
gitcommit-m"initial package setup"Install thepre-commithooks:poetryrunpre-commitinstallUpdate thepre-commithooks' versions:poetryrunpre-commitautoupdateFinally, add to version control:gitadd.pre-commit-config.yamlAnd, commit:gitcommit-m"build: update pre-commit hooks versions"Automatic releaseSetting on github:graph LR
        A[Settings] --> B[Actions]
        B --> C[General]
        C --> D[Workflow<br>permissions]
        D --> E[Read and write<br>permissions]
        E --> F[Save]Thepython-semantic-releasetool do the automated bumping based on theangular commit stylebuild/chore: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)ci: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)docs: Documentation only changesfeat: A new featurefix: A bug fixperf: A code change that improves performancerefactor: A code change that neither fixes a bug nor adds a featuretest: Adding missing tests or correcting existing testsFeaturespre-commit hooks:banditdarglintpyclncheck-added-large-filescheck-astcheck-byte-order-markercheck-builtin-literalscheck-case-conflictcheck-docstring-firstcheck-jsoncheck-merge-conflictcheck-symlinkscheck-tomlcheck-vcs-permalinkscheck-xmlcheck-yamldebug-statementsdestroyed-symlinksdetect-private-keyend-of-file-fixerfile-contents-sorterfix-byte-order-markerfix-encoding-pragmaforbid-new-submodulesmixed-line-endingrequirements-txt-fixersort-simple-yamltrailing-whitespaceprettierpyupgradeisortdocformatterblackblacken-docsflake8flake8-bugbearflake8-docstringsflake8-rst-docstringspep8-namingmypyclickpython-semantic-releasenoxpytestpytest-covsafetytypeguardxdoctestpygmentsjupytermyst-parsersphinx-autobuildsphinx-autoapisphinx-copybuttonfurosphinx-clicksphinxsphinxcontrib-mermaidContributingContributions are very welcome.
To learn more, see theContributor Guide.LicenseDistributed under the terms of theMIT license,Dinkin Flickais free and open source software.IssuesIf you encounter any problems,
pleasefile an issuealong with a detailed description.CreditsThis project was generated fromDinkin Flicka Cookiecuttertemplate.AcknowledgementsDinkin Flicka Cookiecutterwas based onHypermodern Pythonarticle series
andPython Packages book.