From d1cf76e70a7a9518aa2d684e13be400f7ba7a2cc Mon Sep 17 00:00:00 2001 From: mark sevelj <31756570+imAsparky@users.noreply.github.com> Date: Sat, 13 Nov 2021 05:48:45 +0800 Subject: [PATCH] feat(pkge): Added Repo Status option to README #159 (#160) A Repo Status badge communicates to potential users quickly. closes #159 --- CHANGELOG.md | 359 ------------ README.rst | 35 +- cookiecutter.json | 1 + docs/source/CHANGELOG-docs.md | 511 ------------------ .../reference/reference-project-inputs.rst | 7 + requirements_dev.txt | 4 +- tests/test_bake_project.py | 23 +- {{cookiecutter.git_project_name}}/README.rst | 24 +- 8 files changed, 47 insertions(+), 917 deletions(-) delete mode 100644 CHANGELOG.md delete mode 100644 docs/source/CHANGELOG-docs.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 379a3f6..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,359 +0,0 @@ -# CHANGELOG - - - -## v0.9.1 (2021-09-23) -### Fix -* **Hook:** Add missing post_gen_setup return var #125 ([#126](https://github.com/imAsparky/cookiecutter-py3-package/issues/126)) ([`870a107`](https://github.com/imAsparky/cookiecutter-py3-package/commit/870a107243a74fb988bda25f699a83dd25692b5e)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`2a2e430`](https://github.com/imAsparky/cookiecutter-py3-package/commit/2a2e4309ef70f0dad76b28d6b1be36bc1dedc89d)) -* **README:** Fix merge conflict #116 ([`b8c7dc9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/b8c7dc9e854c4407814c634ca1c9c14136de7e84)) -* **Package:** Update README to correct info #114 ([#117](https://github.com/imAsparky/cookiecutter-py3-package/issues/117)) ([`33384e1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/33384e1e436ac32ffcc9f10aaaf7975ec450c519)) - -## v0.9.0 (2021-09-23) -### Feature -* **PyPi:** Deploy to Test PyPi with Tags #13 ([#115](https://github.com/imAsparky/cookiecutter-py3-package/issues/115)) ([`f0fe67f`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f0fe67f105b7c05160f77b42b8d3f149d8e7f62e)) - -### Documentation -* **git:** Notes to alert of a git version bug #112 ([#113](https://github.com/imAsparky/cookiecutter-py3-package/issues/113)) ([`6050722`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6050722858478d2f776f1e3108cf61e4885607bb)) -* **CHANGELOG:** Update release notes:docs ([`522d5a1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/522d5a19f3d9f4886db641863443cc90e1c385f7)) - -## v0.8.0 (2021-09-22) -### Feature -* **git:** Add auto git init-add-commit #102 ([#110](https://github.com/imAsparky/cookiecutter-py3-package/issues/110)) ([`42a531a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/42a531a3c1a5054c99a39eda94a7a9789f9583ec)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`3990c03`](https://github.com/imAsparky/cookiecutter-py3-package/commit/3990c0322ea12f5f2bde7e34256f7d3289f88838)) -* **CHANGELOG:** Update release notes:docs ([`43f4900`](https://github.com/imAsparky/cookiecutter-py3-package/commit/43f4900e71c4cb73eccbb6db6aacd3d1e3f74e0b)) - -## v0.7.1 (2021-09-17) -### Fix -* **ISSUE:** Templates asignees added "" #100 ([#101](https://github.com/imAsparky/cookiecutter-py3-package/issues/101)) ([`aa1d5c7`](https://github.com/imAsparky/cookiecutter-py3-package/commit/aa1d5c763c8ec1b8a119de691b79743ec9e21bcf)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`e3ac506`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e3ac506c431922daddd6b57396eb798e1c6157ef)) - -## v0.7.0 (2021-09-16) -### Feature -* **pre-commit:** Add pre-commit to package #93 ([#99](https://github.com/imAsparky/cookiecutter-py3-package/issues/99)) ([`5ec4067`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5ec40679497df75dd04bec045d00124287a271cf)) - -### Documentation -* **Diataxis:** Add tutes & how-to framework #81 ([#98](https://github.com/imAsparky/cookiecutter-py3-package/issues/98)) ([`322ac5b`](https://github.com/imAsparky/cookiecutter-py3-package/commit/322ac5b1067cf8cad493f08675643cf409daceb0)) - -## v0.6.3 (2021-09-16) - -### Fix - -- **CHANGELOG:** Auto-generate for repo disabled #94 ([#97](https://github.com/imAsparky/cookiecutter-py3-package/issues/97)) ([`f3f6f9c`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f3f6f9cfcce2375f580a089fa3319ace9108dbeb)) - -## v0.6.2 (2021-09-16) - -### Fix - -- **git** Package git url source updated #95 ([#95](https://github.com/imAsparky/cookiecutter-py3-package/issues/95)) ([`1aa3010`](https://github.com/imAsparky/cookiecutter-py3-package/commit/1aa3010a6765ac5f385d23bd464723ae357fa15e)) - -## v0.6.1 (2021-09-16) - -### Fix - -- **deps** Update pkge requirements_dev.txt #91 ([#91](https://github.com/imAsparky/cookiecutter-py3-package/issues/91)) ([`c7f2eeb`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7f2eebaec21bd3fc1ea6e52dedb05738748a350)) - -## [v0.6.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.6.0) - 2021-09-15 07:10:13 - -### Feature - -- **docs:** Add sphinx theme and tools #79 ([#80](https://github.com/imAsparky/cookiecutter-py3-package/issues/80)) ([`60a9388`](https://github.com/imAsparky/cookiecutter-py3-package/commit/60a9388ce54da097b1576850c1345e1fb78e67d1)) - -### Documentation - -- **bump:** Remove bump2version references #71 ([#78](https://github.com/imAsparky/cookiecutter-py3-package/issues/78)) ([`78e61a0`](https://github.com/imAsparky/cookiecutter-py3-package/commit/78e61a0f968046f9da8ad18d10fdc8cb9b995136)) - -### Build - -- version: - - Bump to version - 0.6.0. ([0f088cc](https://github.com/imAsparky/cookiecutter-py3-package/commit/0f088cc53208efc9bf7e62bdf22cf291ca333830)) - -### Documentation - -- bump: - - Remove bump2version references #71 (#78) ([78e61a0](https://github.com/imAsparky/cookiecutter-py3-package/commit/78e61a0f968046f9da8ad18d10fdc8cb9b995136)) ([#78](https://github.com/imAsparky/cookiecutter-py3-package/pull/78)) - -### Feature - -- docs: - - Add sphinx theme and tools #79 (#80) ([60a9388](https://github.com/imAsparky/cookiecutter-py3-package/commit/60a9388ce54da097b1576850c1345e1fb78e67d1)) ([#80](https://github.com/imAsparky/cookiecutter-py3-package/pull/80)) - -## [v0.5.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.5.0) - 2021-09-15 04:19:02 - -### Feature - -- **issues:** Add four custom issue templates #75 ([#77](https://github.com/imAsparky/cookiecutter-py3-package/issues/77)) ([`03bf9c3`](https://github.com/imAsparky/cookiecutter-py3-package/commit/03bf9c3c15dc8a3cd82f3f350bd678c4d0c8fb97)) - -### Documentation - -- **CHANGELOG:** Update release notes:docs ([`472984a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/472984aa5d01057af213fe97d8d6657041684c1e)) -- **CHANGELOG:** Update release notes:repo ([`34fc9b9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/34fc9b9e1b9032af736c2fded5e470a8f627ce66)) - -### Build - -- version: - - Bump to version - 0.5.0. ([647c154](https://github.com/imAsparky/cookiecutter-py3-package/commit/647c1544be0c632c53d4778b1655b5825f66139c)) - -### Feature - -- issues: - - Add four custom issue templates #75 (#77) ([03bf9c3](https://github.com/imAsparky/cookiecutter-py3-package/commit/03bf9c3c15dc8a3cd82f3f350bd678c4d0c8fb97)) ([#77](https://github.com/imAsparky/cookiecutter-py3-package/pull/77)) - -## [v0.4.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.4.0) - 2021-09-14 04:21:25 - -### Feature - -- **version:** Add pkg GH action sem-ver opt #14 ([#74](https://github.com/imAsparky/cookiecutter-py3-package/issues/74)) ([`f619ab6`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f619ab6e78e5a4b393d7c2098def683eeb368266)) - -### Documentation - -- **CHANGELOG:** Update release notes:repo ([`6796ac9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6796ac974538acdc9fb868d58f67186a11d2f71d)) - -### Build - -- version: - - Bump to version - 0.4.0. ([6e86af3](https://github.com/imAsparky/cookiecutter-py3-package/commit/6e86af35036c12f093ee63d3906be87c3d7d275d)) - -### Feature - -- version: - - Add pkg GH action sem-ver opt #14 (#74) ([f619ab6](https://github.com/imAsparky/cookiecutter-py3-package/commit/f619ab6e78e5a4b393d7c2098def683eeb368266)) ([#74](https://github.com/imAsparky/cookiecutter-py3-package/pull/74)) - -## [v0.3.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.3.0) - 2021-09-14 00:56:09 - -### Feature - -- **tests:** Add GH action for autotesting #16 ([#73](https://github.com/imAsparky/cookiecutter-py3-package/issues/73)) ([`a49b767`](https://github.com/imAsparky/cookiecutter-py3-package/commit/a49b767f9baba25f091f5e948458dd995fe83bef)) - -### Documentation - -- **CHANGELOG:** Update release notes:docs ([`c12e2f5`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c12e2f53c2360d5b2eaf15666896a40578df1aca)) -- **CHANGELOG:** Update release notes:repo ([`19dedf4`](https://github.com/imAsparky/cookiecutter-py3-package/commit/19dedf443bf662efd407e7b47902ab8afaea96e5)) - -### Build - -- version: - - Bump to version - 0.3.0. ([adbf1bb](https://github.com/imAsparky/cookiecutter-py3-package/commit/adbf1bb69e62e08d998b016c40ba387b7fc008a1)) - -### Feature - -- tests: - - Add GH action for autotesting #16 (#73) ([a49b767](https://github.com/imAsparky/cookiecutter-py3-package/commit/a49b767f9baba25f091f5e948458dd995fe83bef)) ([#73](https://github.com/imAsparky/cookiecutter-py3-package/pull/73)) - -## [v0.2.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.2.0) - 2021-09-13 09:17:34 - -### Feature - -- **CHANGELOG:** Add auto update opt to pkge #12 ([#70](https://github.com/imAsparky/cookiecutter-py3-package/issues/70)) ([`5e24e40`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5e24e403ecc39b64bbb963570bac7d1d2426a8d0)) - -### Documentation - -- **CHANGELOG:** Update release notes:repo ([`2fba5e5`](https://github.com/imAsparky/cookiecutter-py3-package/commit/2fba5e5a840efd90ba8a443b529398481a461b13)) - -### Build - -- version: - - Bump to version - 0.2.0. ([5eda4ea](https://github.com/imAsparky/cookiecutter-py3-package/commit/5eda4eabedb87b78fb188a9db6db40de912891b2)) - -### Feature - -- CHANGELOG: - - Add auto update opt to pkge #12 (#70) ([5e24e40](https://github.com/imAsparky/cookiecutter-py3-package/commit/5e24e403ecc39b64bbb963570bac7d1d2426a8d0)) ([#70](https://github.com/imAsparky/cookiecutter-py3-package/pull/70)) - -## [v0.1.1](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.1.1) - 2021-09-13 04:36:05 - -### Fix - -- **version:** Update commit_subject #60 ([#68](https://github.com/imAsparky/cookiecutter-py3-package/issues/68)) ([`977acd1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/977acd12519ddf6c03800fd0d78edf93e7c54cb7)) - -### Documentation - -- **CHANGELOG:** Update release notes:docs ([`9d33ebc`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9d33ebc94a18177db6f00b003b4a05dfa3573190)) -- **CHANGELOG:** Update release notes:repo ([`7c5630e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/7c5630e982ab2482867e9a7777da624c55ecf576)) - -### Build - -- version: - - Bump to version - 0.1.1. ([23b10d1](https://github.com/imAsparky/cookiecutter-py3-package/commit/23b10d12f12cf462c2b949166b4b96b77247164f)) - -### Bug Fixes - -- version: - - Update commit_subject #60 (#68) ([977acd1](https://github.com/imAsparky/cookiecutter-py3-package/commit/977acd12519ddf6c03800fd0d78edf93e7c54cb7)) ([#68](https://github.com/imAsparky/cookiecutter-py3-package/pull/68)) - -## [v0.1.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.1.0) - 2021-09-13 03:58:08 - -### Feature - -- **package:** Add Conventional commits msg #15 ([#59](https://github.com/imAsparky/cookiecutter-py3-package/issues/59)) ([`9ce47dc`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9ce47dc73327bdb39d49e5e2074f1320e71d2285)) -- **pre-commit:** Add to pre-commit to GH #31 ([`bf25e6c`](https://github.com/imAsparky/cookiecutter-py3-package/commit/bf25e6cf327670a6e7a38e1464de74a25e447205)) -- **test:** Add GH action to test all contribs #10 ([`9f0787d`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9f0787d7403429186948a38e4b33a1ea8c66ab71)) -- **docs:** Add automatic changelog #8 ([`d14487a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/d14487aa3f3c190a1720884e1c875bdca055cb7d)) -- **docs:** Add automatic changelog #8 ([`0160b52`](https://github.com/imAsparky/cookiecutter-py3-package/commit/0160b52a0a623cc48c8400a5700b1a7460cb6812)) -- **quality:** Add code quality scan and badge #5 ([`fb8fe81`](https://github.com/imAsparky/cookiecutter-py3-package/commit/fb8fe81f4d9439e78a33b00babfa2ab3a7ae380b)) -- **git:** Add pre-commit and sane tests #3 ([`83a8804`](https://github.com/imAsparky/cookiecutter-py3-package/commit/83a88044bfb0ce44e54eb05943f2eb2c4282d195)) -- **git:** Add conventional commits template #2 ([`d808d8e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/d808d8ef08ca158f98bf5a302062f13ab503ab31)) -- **git:** Add additional issue templates #1 ([`6f5c9da`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f5c9da926b158d2116db2cee3f1bf3ac459c86b)) - -### Fix - -- **version:** Add a pre-tested if: condition #60 ([#67](https://github.com/imAsparky/cookiecutter-py3-package/issues/67)) ([`d227bea`](https://github.com/imAsparky/cookiecutter-py3-package/commit/d227bea0eca9b5239438ff61491c2559f6b440c0)) -- **version:** Del manual job & fix concurrency #60 ([#66](https://github.com/imAsparky/cookiecutter-py3-package/issues/66)) ([`6e1c1ca`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6e1c1cadbe20755efb1911768343e6050a293469)) -- **version:** Change to chk_bld_stat false #60 ([#63](https://github.com/imAsparky/cookiecutter-py3-package/issues/63)) ([`cc63fa9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/cc63fa996a00e52c4c91ffcc55eb3056fe1c678f)) -- **version:** Change to python-semantic-release #60 ([#62](https://github.com/imAsparky/cookiecutter-py3-package/issues/62)) ([`83d8d06`](https://github.com/imAsparky/cookiecutter-py3-package/commit/83d8d06ef0f0bee22dc90e4abd32e26ba21bcba6)) -- **version:** Change to python-semantic-release #60 ([#61](https://github.com/imAsparky/cookiecutter-py3-package/issues/61)) ([`88c55f3`](https://github.com/imAsparky/cookiecutter-py3-package/commit/88c55f3755993a9a2a459d9ae367fa39b81fea50)) -- **pre-com:** Fix pre-commit errors #50 ([#51](https://github.com/imAsparky/cookiecutter-py3-package/issues/51)) ([`9360c7f`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9360c7fe47a3e79ae421c5e43ce330414203b2b1)) -- **CHANGELOG:** Fix tox.ini and conf.py #43 ([#47](https://github.com/imAsparky/cookiecutter-py3-package/issues/47)) ([`c7ead74`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7ead747409c6b1997e2524fefd261f7259d0274)) -- **git:** Comment out on:push:main #44 ([#45](https://github.com/imAsparky/cookiecutter-py3-package/issues/45)) ([`3631126`](https://github.com/imAsparky/cookiecutter-py3-package/commit/3631126832b3724859a2cfb58a834205c5948567)) -- **docs:** Add readthedocs.yaml config file #40 ([#42](https://github.com/imAsparky/cookiecutter-py3-package/issues/42)) ([`bc14391`](https://github.com/imAsparky/cookiecutter-py3-package/commit/bc14391f508c585aa8a29f00150c75e4823bc4a0)) -- **git:** Remove test for py3.10 #26 ([`e5fdef2`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e5fdef216b7adf4c0759d85fc2b90a733d2f4426)) - -### Documentation - -- **codes:** Add code of conduct #56 ([#58](https://github.com/imAsparky/cookiecutter-py3-package/issues/58)) ([`b69c126`](https://github.com/imAsparky/cookiecutter-py3-package/commit/b69c1269178d77cee55983992b5a22737197d8b9)) -- **README:** Add pre-commit badge #54 ([#55](https://github.com/imAsparky/cookiecutter-py3-package/issues/55)) ([`08450af`](https://github.com/imAsparky/cookiecutter-py3-package/commit/08450af653d7b175a0327f51e5aaac7643f422c0)) -- **tutorial:** Fix broken pypi checklist link #37 ([#53](https://github.com/imAsparky/cookiecutter-py3-package/issues/53)) ([`f6ec351`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f6ec3518368078b34d25293494b3332027ccb37b)) -- **CHANGELOG:** Add to the documentation #43 ([#46](https://github.com/imAsparky/cookiecutter-py3-package/issues/46)) ([`4a4c643`](https://github.com/imAsparky/cookiecutter-py3-package/commit/4a4c6432c5fabee769119baa7b7c3a859ee53b4e)) -- **logo:** Create and add logo to README #38 ([#41](https://github.com/imAsparky/cookiecutter-py3-package/issues/41)) ([`0ca1adb`](https://github.com/imAsparky/cookiecutter-py3-package/commit/0ca1adb6181138de7b6ccf06fa5984d2c693a169)) -- **update:** Links->cookiecutter-py3-package #20 ([#39](https://github.com/imAsparky/cookiecutter-py3-package/issues/39)) ([`7522aa4`](https://github.com/imAsparky/cookiecutter-py3-package/commit/7522aa4014eda677ec28bbd8154906f69afa8811)) -- **structure:** Update to newer sphinx style #34 ([`6f76c4e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f76c4ead0bb70be7f9630a0fb12ab8f6297bf7d)) -- **README:** Add to list of notable changes ([#24](https://github.com/imAsparky/cookiecutter-py3-package/issues/24)) ([`5db0139`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5db0139e3c21190b3d2085d3c4947beeac2fea25)) -- **fork:** Update to indicate this fork #20 ([`f287b06`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f287b06c8bf40262728bfe2dfe5d542200d0b2ba)) -- **README:** Remove support for Travis CI #18 ([`0dd88fa`](https://github.com/imAsparky/cookiecutter-py3-package/commit/0dd88fa56d5646caddd54828a2640fa96379d0af)) -- **README:** Update to reflect this fork #4 ([`e592c57`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e592c5750e36aff5b8486e0324e8778510498d7c)) - -### Build - -- version: - - Bump to version-0.1.0. ([dbcbc2f](https://github.com/imAsparky/cookiecutter-py3-package/commit/dbcbc2f5eb46b3751aedc2781097aa591f0f5eac)) - -### Chore - -- version: - - - Add workflow_dispatch #60 (#64) ([1df725e](https://github.com/imAsparky/cookiecutter-py3-package/commit/1df725ed6073cf5e690f8b70749a30baede92dd1)) ([#64](https://github.com/imAsparky/cookiecutter-py3-package/pull/64)) - -- pre-commit: - - - Weekly pre-commit autoupdate (#52) ([1cec5ce](https://github.com/imAsparky/cookiecutter-py3-package/commit/1cec5ce9c4db54a2945690906ead6a3f4fd1f420)) ([#52](https://github.com/imAsparky/cookiecutter-py3-package/pull/52)) - -- git: - - - Add vscode workspace folder .gitignore ([c000227](https://github.com/imAsparky/cookiecutter-py3-package/commit/c00022746f83c123ec441bdd010fdd06e8f34b58)) - - Add project folders to .gitignore ([4847e57](https://github.com/imAsparky/cookiecutter-py3-package/commit/4847e574c6b978a3aab14313b12a74d1c879dcd6)) - -- setup: - - - Update to setuptools #27 ([c0d3b0d](https://github.com/imAsparky/cookiecutter-py3-package/commit/c0d3b0dc18a58a947a2d9eea5123a31ae39e843c)) ([#33](https://github.com/imAsparky/cookiecutter-py3-package/pull/33)) - -- Travis: - - - Remove support for Travis #18 ([ade1959](https://github.com/imAsparky/cookiecutter-py3-package/commit/ade1959381459abb179df2b3a7c1e25ae695f3db)) ([#23](https://github.com/imAsparky/cookiecutter-py3-package/pull/23)) - - Remove support #18 ([aa463f4](https://github.com/imAsparky/cookiecutter-py3-package/commit/aa463f412f26a03a9c1cc278b9bca56e54f114a2)) ([#21](https://github.com/imAsparky/cookiecutter-py3-package/pull/21)) - -- README: - - - Remove stale Similar Templates #11 ([2b62df5](https://github.com/imAsparky/cookiecutter-py3-package/commit/2b62df5f7cf28f6b10fcc17ecebc6dec6dd550e2)) - -- docs: - - - Comment on:push out for CHANGELOG ([ce7b075](https://github.com/imAsparky/cookiecutter-py3-package/commit/ce7b075187b060ca036e34a65f7f8e52a4ab1f0d)) - -- test: - - Rename workflow #10 ([d4a709b](https://github.com/imAsparky/cookiecutter-py3-package/commit/d4a709bcc6f8a431363b1837c3e78a6718f0ec44)) - - Fix typo in jobs:name: #10 ([38f6a89](https://github.com/imAsparky/cookiecutter-py3-package/commit/38f6a89d02b3512f143b6e74b775b8cdbaa2882a)) - - Add test coverage Py39 Py3-10 #7 ([a7a9219](https://github.com/imAsparky/cookiecutter-py3-package/commit/a7a921961c2d439ac0724fc539249520f73c6c72)) - -### Documentation - -- codes: - - - Add code of conduct #56 (#58) ([b69c126](https://github.com/imAsparky/cookiecutter-py3-package/commit/b69c1269178d77cee55983992b5a22737197d8b9)) ([#58](https://github.com/imAsparky/cookiecutter-py3-package/pull/58)) - -- README: - - - Add pre-commit badge #54 (#55) ([08450af](https://github.com/imAsparky/cookiecutter-py3-package/commit/08450af653d7b175a0327f51e5aaac7643f422c0)) ([#55](https://github.com/imAsparky/cookiecutter-py3-package/pull/55)) - - Add to list of notable changes (#24) ([5db0139](https://github.com/imAsparky/cookiecutter-py3-package/commit/5db0139e3c21190b3d2085d3c4947beeac2fea25)) ([#24](https://github.com/imAsparky/cookiecutter-py3-package/pull/24)) - - Remove support for Travis CI #18 ([0dd88fa](https://github.com/imAsparky/cookiecutter-py3-package/commit/0dd88fa56d5646caddd54828a2640fa96379d0af)) - - Update to reflect this fork #4 ([e592c57](https://github.com/imAsparky/cookiecutter-py3-package/commit/e592c5750e36aff5b8486e0324e8778510498d7c)) - -- tutorial: - - - Fix broken pypi checklist link #37 (#53) ([f6ec351](https://github.com/imAsparky/cookiecutter-py3-package/commit/f6ec3518368078b34d25293494b3332027ccb37b)) ([#53](https://github.com/imAsparky/cookiecutter-py3-package/pull/53)) - -- logo: - - - Create and add logo to README #38 (#41) ([0ca1adb](https://github.com/imAsparky/cookiecutter-py3-package/commit/0ca1adb6181138de7b6ccf06fa5984d2c693a169)) ([#41](https://github.com/imAsparky/cookiecutter-py3-package/pull/41)) - -- update: - - - Links->cookiecutter-py3-package #20 (#39) ([7522aa4](https://github.com/imAsparky/cookiecutter-py3-package/commit/7522aa4014eda677ec28bbd8154906f69afa8811)) ([#39](https://github.com/imAsparky/cookiecutter-py3-package/pull/39)) - -- structure: - - - Update to newer sphinx style #34 ([6f76c4e](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f76c4ead0bb70be7f9630a0fb12ab8f6297bf7d)) ([#35](https://github.com/imAsparky/cookiecutter-py3-package/pull/35)) - -- fork: - - Update to indicate this fork #20 ([f287b06](https://github.com/imAsparky/cookiecutter-py3-package/commit/f287b06c8bf40262728bfe2dfe5d542200d0b2ba)) - -### Feature - -- package: - - - Add Conventional commits msg #15 (#59) ([9ce47dc](https://github.com/imAsparky/cookiecutter-py3-package/commit/9ce47dc73327bdb39d49e5e2074f1320e71d2285)) ([#59](https://github.com/imAsparky/cookiecutter-py3-package/pull/59)) - -- pre-commit: - - - Add to pre-commit GH #31 ([bf25e6c](https://github.com/imAsparky/cookiecutter-py3-package/commit/bf25e6cf327670a6e7a38e1464de74a25e447205)) ([#32](https://github.com/imAsparky/cookiecutter-py3-package/pull/32)) - -- test: - - - Add GH action to test all contribs #10 ([9f0787d](https://github.com/imAsparky/cookiecutter-py3-package/commit/9f0787d7403429186948a38e4b33a1ea8c66ab71)) - -- docs: - - - Add automatic changelog #8 ([d14487a](https://github.com/imAsparky/cookiecutter-py3-package/commit/d14487aa3f3c190a1720884e1c875bdca055cb7d)) - - Add automatic changelog #8 ([0160b52](https://github.com/imAsparky/cookiecutter-py3-package/commit/0160b52a0a623cc48c8400a5700b1a7460cb6812)) - -- quality: - - - Add code quality scan and badge #5 ([fb8fe81](https://github.com/imAsparky/cookiecutter-py3-package/commit/fb8fe81f4d9439e78a33b00babfa2ab3a7ae380b)) - -- git: - - Add pre-commit and sane tests #3 ([83a8804](https://github.com/imAsparky/cookiecutter-py3-package/commit/83a88044bfb0ce44e54eb05943f2eb2c4282d195)) - - Add conventional commits template #2 ([d808d8e](https://github.com/imAsparky/cookiecutter-py3-package/commit/d808d8ef08ca158f98bf5a302062f13ab503ab31)) - - Add additional issue templates #1 ([6f5c9da](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f5c9da926b158d2116db2cee3f1bf3ac459c86b)) - -### Bug Fixes - -- version: - - - Add a pre-tested if: condition #60 (#67) ([d227bea](https://github.com/imAsparky/cookiecutter-py3-package/commit/d227bea0eca9b5239438ff61491c2559f6b440c0)) ([#67](https://github.com/imAsparky/cookiecutter-py3-package/pull/67)) - - Del manual job & fix concurrency #60 (#66) ([6e1c1ca](https://github.com/imAsparky/cookiecutter-py3-package/commit/6e1c1cadbe20755efb1911768343e6050a293469)) ([#66](https://github.com/imAsparky/cookiecutter-py3-package/pull/66)) - - change to chk_bld_stat false #60 (#63) ([cc63fa9](https://github.com/imAsparky/cookiecutter-py3-package/commit/cc63fa996a00e52c4c91ffcc55eb3056fe1c678f)) ([#63](https://github.com/imAsparky/cookiecutter-py3-package/pull/63)) - - Change to python-semantic-release #60 (#62) ([83d8d06](https://github.com/imAsparky/cookiecutter-py3-package/commit/83d8d06ef0f0bee22dc90e4abd32e26ba21bcba6)) ([#62](https://github.com/imAsparky/cookiecutter-py3-package/pull/62)) - - Change to python-semantic-release #60 (#61) ([88c55f3](https://github.com/imAsparky/cookiecutter-py3-package/commit/88c55f3755993a9a2a459d9ae367fa39b81fea50)) ([#61](https://github.com/imAsparky/cookiecutter-py3-package/pull/61)) - -- pre-com: - - - Fix pre-commit errors #50 (#51) ([9360c7f](https://github.com/imAsparky/cookiecutter-py3-package/commit/9360c7fe47a3e79ae421c5e43ce330414203b2b1)) ([#51](https://github.com/imAsparky/cookiecutter-py3-package/pull/51)) - -- CHANGELOG: - - - Fix tox.ini and conf.py #43 (#47) ([c7ead74](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7ead747409c6b1997e2524fefd261f7259d0274)) ([#47](https://github.com/imAsparky/cookiecutter-py3-package/pull/47)) - -- git: - - - Comment out on:push:main #44 (#45) ([3631126](https://github.com/imAsparky/cookiecutter-py3-package/commit/3631126832b3724859a2cfb58a834205c5948567)) ([#45](https://github.com/imAsparky/cookiecutter-py3-package/pull/45)) - - Remove test for py3.10 #26 ([e5fdef2](https://github.com/imAsparky/cookiecutter-py3-package/commit/e5fdef216b7adf4c0759d85fc2b90a733d2f4426)) - -- docs: - - Add readthedocs.yaml config file #40 (#42) ([bc14391](https://github.com/imAsparky/cookiecutter-py3-package/commit/bc14391f508c585aa8a29f00150c75e4823bc4a0)) ([#42](https://github.com/imAsparky/cookiecutter-py3-package/pull/42)) - -\* _This CHANGELOG was automatically generated by [auto-generate-changelog](https://github.com/BobAnkh/auto-generate-changelog)_ diff --git a/README.rst b/README.rst index 5f45da0..b866816 100644 --- a/README.rst +++ b/README.rst @@ -20,13 +20,7 @@ **We are aiming for your new package to be an automated Continuous Delivery workflow experience.** -.. .. image:: https://pyup.io/repos/github/audreyfeldroy/cookiecutter-pypackage/shield.svg -.. :target: https://pyup.io/repos/github/audreyfeldroy/cookiecutter-pypackage/ -.. :alt: Updates - -.. .. image:: https://travis-ci.org/audreyfeldroy/cookiecutter-pypackage.svg?branch=master -.. :target: https://travis-ci.org/github/audreyfeldroy/cookiecutter-pypackage -.. :alt: Build Status +| .. image:: https://www.repostatus.org/badges/latest/wip.svg :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. @@ -63,7 +57,7 @@ A Cookiecutter_ template for a Python package. Features -------- -#. Choose to use a Conventional-Commits_ specification custom commits message +#. Choose to use a `Conventional-Commits`_ specification custom commits message in your built package. #. An optional GitHub action to automatically update semantic version and publish assets to your package repository when a pull request merge is @@ -72,38 +66,37 @@ Features bypassing the need for a GitHub action if that is your preferred workflow. #. An optional GitHub action to generate a package CHANGELOG automatically if you choose to version and publish your package manually. -#. An optional GitHub action to run your Tox_ package test suite when a +#. An optional GitHub action to run your `Tox`_ package test suite when a pull request to the main branch starts. -#. Tox_ configuration for your package includes an OS and Python test matrix. +#. `Tox`_ configuration for your package includes an OS and Python test matrix. OS includes Linux, macOS and Windows. Python 3.6 - 3.9. (Uses GitHub actions.) #. An optional suite of custom GitHub issue templates. The four custom issue templates prompt users to help provide enough information in a templated format for each issue type. #. Documentation is in the process of being refreshed and organised into the - Diataxis_ documentation framework. -#. Sphinx_ docs: Documentation ready for generation with, for example, `Read the Docs`_. -#. Auto-release to PyPI_ when you push a new tag to main (optional). Coming soon. -#. Use commit tags to release to Test-PyPi_. Coming soon. + `Diataxis`_ documentation framework. +#. `Sphinx`_ docs: Documentation ready for generation with, for example, `Read the Docs`_. +#. Auto-release to `PyPI`_ when you push a new tag to main (optional). Coming soon. +#. Use commit tags to release to `Test-PyPi`_. Coming soon. #. An optional Command line interface using Click or Argparse. #. An option to initialise your local git repository, add files and create the first commit automatically. Also if you have opted to use the - Conventional-Commits_ style git commit message template, cookiecutter + `Conventional-Commits`_ style git commit message template, cookiecutter will simultaneously add it to your local git config file. -#. Optional to use Test PyPi. Create a git `dev` tag before you push - to the repository. +#. Optional to use to use a `Repo Status`_ badge to communicate quickly. .. note:: - Initialise your local git requires Git v2.33.0 or above. A bug report has - been raised and a fix is coming. + Initialise your local git requires Git v2.33.0 or above. .. _Cookiecutter: https://github.com/cookiecutter/cookiecutter .. _cookiecutter-pypackage: https://github.com/audreyfeldroy/cookiecutter-pypackage .. _Projects: https://github.com/imAsparky/cookiecutter-py3-package/projects -.. _CHANGELOG: https://github.com/imAsparky/cookiecutter-py3-package/blob/main/CHANGELOG.md +.. _CHANGELOG: https://github.com/imAsparky/cookiecutter-py3-package/blob/main/docs/source/CHANGELOG.md .. _Test-PyPi: https://test.pypi.org/ .. _Conventional-Commits: https://www.conventionalcommits.org/en/v1.0.0/ .. _Diataxis: https://diataxis.fr/ +.. _Repo Status: https://www.repostatus.org/ Quickstart ---------- @@ -177,7 +170,7 @@ make my own packaging experience better. .. _Poetry: https://python-poetry.org/ .. _PyPi: https://pypi.python.org/pypi .. _Mkdocs: https://pypi.org/project/mkdocs/ -.. _Quickstart: https://cookiecutter-py3-package.readthedocs.io/en/latest/how-to/how-to-quickstart.html +.. _quickstart: https://cookiecutter-py3-package.readthedocs.io/en/latest/how-to/how-to-quickstart.html .. _cookiecutter-py3-pypackage tutorial: https://cookiecutter-py3-package.readthedocs.io/en/latest/tutorial.html diff --git a/cookiecutter.json b/cookiecutter.json index a25c273..418075b 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -8,6 +8,7 @@ "project_short_description": "Python 3 Package Boilerplate contains all the boilerplate you need to create a Python package.", "pypi_username": "{{ cookiecutter.github_username }}", "version": "0.1.0", + "use_repo_status_badge": ["no", "concept", "wip", "active"], "add_pyup_badge": "n", "command_line_interface": ["Click", "Argparse", "No command-line interface"], "create_author_file": "y", diff --git a/docs/source/CHANGELOG-docs.md b/docs/source/CHANGELOG-docs.md deleted file mode 100644 index e9b2034..0000000 --- a/docs/source/CHANGELOG-docs.md +++ /dev/null @@ -1,511 +0,0 @@ -# CHANGELOG - -## Unreleased - -Changes unreleased. - -### Chore - -- test: - - Add pytest.ini to package #133 (#135) ([a07a43b](https://github.com/imAsparky/cookiecutter-py3-package/commit/a07a43bfc32d3b9aa48cf91f4e12537250dcf895)) ([#135](https://github.com/imAsparky/cookiecutter-py3-package/pull/135)) - -- sphinx: - - Update package docs structure #128 (#130) ([a50283f](https://github.com/imAsparky/cookiecutter-py3-package/commit/a50283f445fe0c40d1f5d102b0500c091ab5f01f)) ([#130](https://github.com/imAsparky/cookiecutter-py3-package/pull/130)) - -- sem_ver: - - Add settings to setup.cfg #127 (#128) ([a9abe78](https://github.com/imAsparky/cookiecutter-py3-package/commit/a9abe7843cb578a9b7dbb7f3680a37a193d40faa)) ([#128](https://github.com/imAsparky/cookiecutter-py3-package/pull/128)) - -### Documentation - -- how-to: - - Add several how-tos #82 #149 (#152) ([40e2bab](https://github.com/imAsparky/cookiecutter-py3-package/commit/40e2bab76540561bc907974ba3ea461230026370)) ([#152](https://github.com/imAsparky/cookiecutter-py3-package/pull/152)) - -- cookie: - - Fix typo in create-github-repo tutorial #147 (#150) ([8754ee8](https://github.com/imAsparky/cookiecutter-py3-package/commit/8754ee875ba252a0276ddc561f0362f1c6388fd5)) ([#150](https://github.com/imAsparky/cookiecutter-py3-package/pull/150)) - - Fix typo in create-github-repo tutorial #147 (#148) ([a9e8092](https://github.com/imAsparky/cookiecutter-py3-package/commit/a9e809238fad6b1a6dc79c3dacaa03c023481073)) ([#148](https://github.com/imAsparky/cookiecutter-py3-package/pull/148)) - -- tutorial: - - Add Codacy GitHub integration #22 (#145) ([1d86da3](https://github.com/imAsparky/cookiecutter-py3-package/commit/1d86da3d5d3f17365214bdd5b400c4f866fd4a7c)) ([#145](https://github.com/imAsparky/cookiecutter-py3-package/pull/145)) - - Add context to various tutes #143 (#144) ([4b7940a](https://github.com/imAsparky/cookiecutter-py3-package/commit/4b7940a7a2a195015920173081b524b677bec8c6)) ([#144](https://github.com/imAsparky/cookiecutter-py3-package/pull/144)) - - Add git first push with CLI #139 (#142) ([ec6cbd6](https://github.com/imAsparky/cookiecutter-py3-package/commit/ec6cbd666fcfb5a39c65764af5df9617eec6a877)) ([#142](https://github.com/imAsparky/cookiecutter-py3-package/pull/142)) - - Add cookie-create sample info #140 (#141) ([8ede3de](https://github.com/imAsparky/cookiecutter-py3-package/commit/8ede3de51b77b6e1328912d1bc9a08687bfb2705)) ([#141](https://github.com/imAsparky/cookiecutter-py3-package/pull/141)) - - Add Create a Github Repo #83 (#138) ([84aeffa](https://github.com/imAsparky/cookiecutter-py3-package/commit/84aeffa8aad54a2083870be63a9c4351c9ba446d)) ([#138](https://github.com/imAsparky/cookiecutter-py3-package/pull/138)) - - Add create a package. #84 (#137) ([8d8f41b](https://github.com/imAsparky/cookiecutter-py3-package/commit/8d8f41b05fd2296076b161c540f624ce5a1b05f4)) ([#137](https://github.com/imAsparky/cookiecutter-py3-package/pull/137)) - -### Refactor - -- setup: - - Add encodings and test_req #131 (#132) ([5b2b014](https://github.com/imAsparky/cookiecutter-py3-package/commit/5b2b0144219b37db2c8524e559af60ea2c1a5418)) ([#132](https://github.com/imAsparky/cookiecutter-py3-package/pull/132)) - -### Tests - -- pkge: - - Add unitest import and refactor #134 (#136) ([70cfc56](https://github.com/imAsparky/cookiecutter-py3-package/commit/70cfc56a313907c6b5de53147b8edee3e37d9fd9)) ([#136](https://github.com/imAsparky/cookiecutter-py3-package/pull/136)) - -## [v0.9.1](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.9.1) - 2021-09-23 22:51:36 - -### Fix -* **Hook:** Add missing post_gen_setup return var #125 ([#126](https://github.com/imAsparky/cookiecutter-py3-package/issues/126)) ([`870a107`](https://github.com/imAsparky/cookiecutter-py3-package/commit/870a107243a74fb988bda25f699a83dd25692b5e)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`2a2e430`](https://github.com/imAsparky/cookiecutter-py3-package/commit/2a2e4309ef70f0dad76b28d6b1be36bc1dedc89d)) -* **README:** Fix merge conflict #116 ([`b8c7dc9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/b8c7dc9e854c4407814c634ca1c9c14136de7e84)) -* **Package:** Update README to correct info #114 ([#117](https://github.com/imAsparky/cookiecutter-py3-package/issues/117)) ([`33384e1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/33384e1e436ac32ffcc9f10aaaf7975ec450c519)) - -### Build - -- version: - - Bump to version - 0.9.1. ([ada8ac3](https://github.com/imAsparky/cookiecutter-py3-package/commit/ada8ac338249564a36170bc5936a3731f0664156)) - -### Chore - -- git: - - Fix typo missing "push" in on: #123 (#124) ([ede69f3](https://github.com/imAsparky/cookiecutter-py3-package/commit/ede69f336e2ee0de2e36b7e96e84b8a03e6efe38)) ([#124](https://github.com/imAsparky/cookiecutter-py3-package/pull/124)) - -- options: - - Remove pytest and black #103 (#122) ([85a729f](https://github.com/imAsparky/cookiecutter-py3-package/commit/85a729f8dd4d68b674d6f5baa5c40ef34c96567b)) ([#122](https://github.com/imAsparky/cookiecutter-py3-package/pull/122)) - -- root: - - Folder name now git_project_name #116 ([2e5457d](https://github.com/imAsparky/cookiecutter-py3-package/commit/2e5457d8c3679e0aee9d35fce12272077bbf045a)) ([#121](https://github.com/imAsparky/cookiecutter-py3-package/pull/121)) - - Folder name now git_project_name #116 ([2fec02a](https://github.com/imAsparky/cookiecutter-py3-package/commit/2fec02a327c0d1bf058f21f31e623dfae23adb20)) ([#119](https://github.com/imAsparky/cookiecutter-py3-package/pull/119)) - -### Documentation - -- README: - - Fix merge conflict #116 ([b8c7dc9](https://github.com/imAsparky/cookiecutter-py3-package/commit/b8c7dc9e854c4407814c634ca1c9c14136de7e84)) ([#119](https://github.com/imAsparky/cookiecutter-py3-package/pull/119)) - -- Package: - - Update README to correct info #114 (#117) ([33384e1](https://github.com/imAsparky/cookiecutter-py3-package/commit/33384e1e436ac32ffcc9f10aaaf7975ec450c519)) ([#117](https://github.com/imAsparky/cookiecutter-py3-package/pull/117)) - -### Bug Fixes - -- Hook: - - Add missing post_gen_setup return var #125 (#126) ([870a107](https://github.com/imAsparky/cookiecutter-py3-package/commit/870a107243a74fb988bda25f699a83dd25692b5e)) ([#126](https://github.com/imAsparky/cookiecutter-py3-package/pull/126)) - -## [v0.9.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.9.0) - 2021-09-23 02:21:39 - -### Feature -* **PyPi:** Deploy to Test PyPi with Tags #13 ([#115](https://github.com/imAsparky/cookiecutter-py3-package/issues/115)) ([`f0fe67f`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f0fe67f105b7c05160f77b42b8d3f149d8e7f62e)) - -### Documentation -* **git:** Notes to alert of a git version bug #112 ([#113](https://github.com/imAsparky/cookiecutter-py3-package/issues/113)) ([`6050722`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6050722858478d2f776f1e3108cf61e4885607bb)) -* **CHANGELOG:** Update release notes:docs ([`522d5a1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/522d5a19f3d9f4886db641863443cc90e1c385f7)) - -### Build - -- version: - - Bump to version - 0.9.0. ([1680a06](https://github.com/imAsparky/cookiecutter-py3-package/commit/1680a066afdea9482414da573474db829703b045)) - -### Chore - -- pre-commit: - - Add additional checks #105 (#111) ([2b57db7](https://github.com/imAsparky/cookiecutter-py3-package/commit/2b57db700be2f5bc0e52d1c8ea4f579e3fd8706d)) ([#111](https://github.com/imAsparky/cookiecutter-py3-package/pull/111)) - -### Documentation - -- git: - - Notes to alert of a git version bug #112 (#113) ([6050722](https://github.com/imAsparky/cookiecutter-py3-package/commit/6050722858478d2f776f1e3108cf61e4885607bb)) ([#113](https://github.com/imAsparky/cookiecutter-py3-package/pull/113)) - -### Feature - -- PyPi: - - Deploy to Test PyPi with Tags #13 (#115) ([f0fe67f](https://github.com/imAsparky/cookiecutter-py3-package/commit/f0fe67f105b7c05160f77b42b8d3f149d8e7f62e)) ([#115](https://github.com/imAsparky/cookiecutter-py3-package/pull/115)) - -## [v0.8.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.8.0) - 2021-09-22 03:02:17 - -### Feature -* **git:** Add auto git init-add-commit #102 ([#110](https://github.com/imAsparky/cookiecutter-py3-package/issues/110)) ([`42a531a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/42a531a3c1a5054c99a39eda94a7a9789f9583ec)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`3990c03`](https://github.com/imAsparky/cookiecutter-py3-package/commit/3990c0322ea12f5f2bde7e34256f7d3289f88838)) -* **CHANGELOG:** Update release notes:docs ([`43f4900`](https://github.com/imAsparky/cookiecutter-py3-package/commit/43f4900e71c4cb73eccbb6db6aacd3d1e3f74e0b)) - -### Build - -- version: - - Bump to version - 0.8.0. ([27d9a5f](https://github.com/imAsparky/cookiecutter-py3-package/commit/27d9a5f2e930005726fa286283468ac6f9665154)) - -### Chore - -- pre-commit: - - Add additional checks #105 (#107) ([9ae8906](https://github.com/imAsparky/cookiecutter-py3-package/commit/9ae890697ce0b49e0f837ac1f426b087260477cc)) ([#107](https://github.com/imAsparky/cookiecutter-py3-package/pull/107)) - - Add additional checks #105 (#106) ([2f96b6e](https://github.com/imAsparky/cookiecutter-py3-package/commit/2f96b6e4e0b1719e499c4679c53d365af73a763b)) ([#106](https://github.com/imAsparky/cookiecutter-py3-package/pull/106)) - -### Feature - -- git: - - Add auto git init-add-commit #102 (#110) ([42a531a](https://github.com/imAsparky/cookiecutter-py3-package/commit/42a531a3c1a5054c99a39eda94a7a9789f9583ec)) ([#110](https://github.com/imAsparky/cookiecutter-py3-package/pull/110)) - -## [v0.7.1](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.7.1) - 2021-09-17 00:26:19 - -### Fix -* **ISSUE:** Templates asignees added "" #100 ([#101](https://github.com/imAsparky/cookiecutter-py3-package/issues/101)) ([`aa1d5c7`](https://github.com/imAsparky/cookiecutter-py3-package/commit/aa1d5c763c8ec1b8a119de691b79743ec9e21bcf)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`e3ac506`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e3ac506c431922daddd6b57396eb798e1c6157ef)) - -### Build - -- version: - - Bump to version - 0.7.1. ([8591d38](https://github.com/imAsparky/cookiecutter-py3-package/commit/8591d38caebc72e19b4980fe38ea16684706f7b3)) - -### Bug Fixes - -- ISSUE: - - Templates asignees added "" #100 (#101) ([aa1d5c7](https://github.com/imAsparky/cookiecutter-py3-package/commit/aa1d5c763c8ec1b8a119de691b79743ec9e21bcf)) ([#101](https://github.com/imAsparky/cookiecutter-py3-package/pull/101)) - -## [v0.7.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.7.0) - 2021-09-16 09:54:30 - -### Feature -* **pre-commit:** Add pre-commit to package #93 ([#99](https://github.com/imAsparky/cookiecutter-py3-package/issues/99)) ([`5ec4067`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5ec40679497df75dd04bec045d00124287a271cf)) - -### Documentation -* **Diataxis:** Add tutes & how-to framework #81 ([#98](https://github.com/imAsparky/cookiecutter-py3-package/issues/98)) ([`322ac5b`](https://github.com/imAsparky/cookiecutter-py3-package/commit/322ac5b1067cf8cad493f08675643cf409daceb0)) - -### Build - -- version: - - Bump to version - 0.7.0. ([25c8146](https://github.com/imAsparky/cookiecutter-py3-package/commit/25c81462bbd132694386028996ac3eb9c8e7e72e)) - -### Documentation - -- Diataxis: - - Add tutes & how-to framework #81 (#98) ([322ac5b](https://github.com/imAsparky/cookiecutter-py3-package/commit/322ac5b1067cf8cad493f08675643cf409daceb0)) ([#98](https://github.com/imAsparky/cookiecutter-py3-package/pull/98)) - -### Feature - -- pre-commit: - - Add pre-commit to package #93 (#99) ([5ec4067](https://github.com/imAsparky/cookiecutter-py3-package/commit/5ec40679497df75dd04bec045d00124287a271cf)) ([#99](https://github.com/imAsparky/cookiecutter-py3-package/pull/99)) - -## [v0.6.3](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.6.3) - 2021-09-16 04:59:55 - -### Fix -* **CHANGELOG:** Auto-generate for repo disabled #94 ([#97](https://github.com/imAsparky/cookiecutter-py3-package/issues/97)) ([`f3f6f9c`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f3f6f9cfcce2375f580a089fa3319ace9108dbeb)) - -### Build - -- version: - - Bump to version - 0.6.3. ([f83d972](https://github.com/imAsparky/cookiecutter-py3-package/commit/f83d972af6fab2d506c12c207d1b771a1188f802)) - -### Bug Fixes - -- CHANGELOG: - - Auto-generate for repo disabled #94 (#97) ([f3f6f9c](https://github.com/imAsparky/cookiecutter-py3-package/commit/f3f6f9cfcce2375f580a089fa3319ace9108dbeb)) ([#97](https://github.com/imAsparky/cookiecutter-py3-package/pull/97)) - -## [v0.6.2](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.6.2) - 2021-09-16 04:32:49 - -### Fix -* **git:** Package git url source updated #95 ([#96](https://github.com/imAsparky/cookiecutter-py3-package/issues/96)) ([`1aa3010`](https://github.com/imAsparky/cookiecutter-py3-package/commit/1aa3010a6765ac5f385d23bd464723ae357fa15e)) - -### Build - -- version: - - Bump to version - 0.6.2. ([5ed6424](https://github.com/imAsparky/cookiecutter-py3-package/commit/5ed64249d6a67c01959806a983443a36073ef169)) - -### Bug Fixes - -- git: - - Package git url source updated #95 (#96) ([1aa3010](https://github.com/imAsparky/cookiecutter-py3-package/commit/1aa3010a6765ac5f385d23bd464723ae357fa15e)) ([#96](https://github.com/imAsparky/cookiecutter-py3-package/pull/96)) - -## [v0.6.1](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.6.1) - 2021-09-16 03:43:49 - -### Fix -* **deps:** Update pkge requirements_dev.txt #91 ([#92](https://github.com/imAsparky/cookiecutter-py3-package/issues/92)) ([`c7f2eeb`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7f2eebaec21bd3fc1ea6e52dedb05738748a350)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`14a3fdb`](https://github.com/imAsparky/cookiecutter-py3-package/commit/14a3fdbda0531226823b050fa4a4b992e442e9a8)) -* **CHANGELOG:** Update release notes:repo ([`2949c5f`](https://github.com/imAsparky/cookiecutter-py3-package/commit/2949c5f2ea1c5c5a411fbfe14ee2091c8f85cd12)) - -### Build - -- version: - - Bump to version - 0.6.1. ([c386143](https://github.com/imAsparky/cookiecutter-py3-package/commit/c3861438c3f6dff031504dae608b51d0f4fbd6bf)) - -### Bug Fixes - -- deps: - - Update pkge requirements_dev.txt #91 (#92) ([c7f2eeb](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7f2eebaec21bd3fc1ea6e52dedb05738748a350)) ([#92](https://github.com/imAsparky/cookiecutter-py3-package/pull/92)) - -## [v0.6.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.6.0) - 2021-09-15 07:10:13 - -### Feature -* **docs:** Add sphinx theme and tools #79 ([#80](https://github.com/imAsparky/cookiecutter-py3-package/issues/80)) ([`60a9388`](https://github.com/imAsparky/cookiecutter-py3-package/commit/60a9388ce54da097b1576850c1345e1fb78e67d1)) - -### Documentation -* **bump:** Remove bump2version references #71 ([#78](https://github.com/imAsparky/cookiecutter-py3-package/issues/78)) ([`78e61a0`](https://github.com/imAsparky/cookiecutter-py3-package/commit/78e61a0f968046f9da8ad18d10fdc8cb9b995136)) - -### Build - -- version: - - Bump to version - 0.6.0. ([0f088cc](https://github.com/imAsparky/cookiecutter-py3-package/commit/0f088cc53208efc9bf7e62bdf22cf291ca333830)) - -### Documentation - -- bump: - - Remove bump2version references #71 (#78) ([78e61a0](https://github.com/imAsparky/cookiecutter-py3-package/commit/78e61a0f968046f9da8ad18d10fdc8cb9b995136)) ([#78](https://github.com/imAsparky/cookiecutter-py3-package/pull/78)) - -### Feature - -- docs: - - Add sphinx theme and tools #79 (#80) ([60a9388](https://github.com/imAsparky/cookiecutter-py3-package/commit/60a9388ce54da097b1576850c1345e1fb78e67d1)) ([#80](https://github.com/imAsparky/cookiecutter-py3-package/pull/80)) - -## [v0.5.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.5.0) - 2021-09-15 04:19:02 - -### Feature -* **issues:** Add four custom issue templates #75 ([#77](https://github.com/imAsparky/cookiecutter-py3-package/issues/77)) ([`03bf9c3`](https://github.com/imAsparky/cookiecutter-py3-package/commit/03bf9c3c15dc8a3cd82f3f350bd678c4d0c8fb97)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`472984a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/472984aa5d01057af213fe97d8d6657041684c1e)) -* **CHANGELOG:** Update release notes:repo ([`34fc9b9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/34fc9b9e1b9032af736c2fded5e470a8f627ce66)) - -### Build - -- version: - - Bump to version - 0.5.0. ([647c154](https://github.com/imAsparky/cookiecutter-py3-package/commit/647c1544be0c632c53d4778b1655b5825f66139c)) - -### Feature - -- issues: - - Add four custom issue templates #75 (#77) ([03bf9c3](https://github.com/imAsparky/cookiecutter-py3-package/commit/03bf9c3c15dc8a3cd82f3f350bd678c4d0c8fb97)) ([#77](https://github.com/imAsparky/cookiecutter-py3-package/pull/77)) - -## [v0.4.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.4.0) - 2021-09-14 04:21:25 - -### Feature -* **version:** Add pkg GH action sem-ver opt #14 ([#74](https://github.com/imAsparky/cookiecutter-py3-package/issues/74)) ([`f619ab6`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f619ab6e78e5a4b393d7c2098def683eeb368266)) - -### Documentation -* **CHANGELOG:** Update release notes:repo ([`6796ac9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6796ac974538acdc9fb868d58f67186a11d2f71d)) - -### Build - -- version: - - Bump to version - 0.4.0. ([6e86af3](https://github.com/imAsparky/cookiecutter-py3-package/commit/6e86af35036c12f093ee63d3906be87c3d7d275d)) - -### Feature - -- version: - - Add pkg GH action sem-ver opt #14 (#74) ([f619ab6](https://github.com/imAsparky/cookiecutter-py3-package/commit/f619ab6e78e5a4b393d7c2098def683eeb368266)) ([#74](https://github.com/imAsparky/cookiecutter-py3-package/pull/74)) - -## [v0.3.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.3.0) - 2021-09-14 00:56:09 - -### Feature -* **tests:** Add GH action for autotesting #16 ([#73](https://github.com/imAsparky/cookiecutter-py3-package/issues/73)) ([`a49b767`](https://github.com/imAsparky/cookiecutter-py3-package/commit/a49b767f9baba25f091f5e948458dd995fe83bef)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`c12e2f5`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c12e2f53c2360d5b2eaf15666896a40578df1aca)) -* **CHANGELOG:** Update release notes:repo ([`19dedf4`](https://github.com/imAsparky/cookiecutter-py3-package/commit/19dedf443bf662efd407e7b47902ab8afaea96e5)) - -### Build - -- version: - - Bump to version - 0.3.0. ([adbf1bb](https://github.com/imAsparky/cookiecutter-py3-package/commit/adbf1bb69e62e08d998b016c40ba387b7fc008a1)) - -### Feature - -- tests: - - Add GH action for autotesting #16 (#73) ([a49b767](https://github.com/imAsparky/cookiecutter-py3-package/commit/a49b767f9baba25f091f5e948458dd995fe83bef)) ([#73](https://github.com/imAsparky/cookiecutter-py3-package/pull/73)) - -## [v0.2.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.2.0) - 2021-09-13 09:17:34 - -### Feature -* **CHANGELOG:** Add auto update opt to pkge #12 ([#70](https://github.com/imAsparky/cookiecutter-py3-package/issues/70)) ([`5e24e40`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5e24e403ecc39b64bbb963570bac7d1d2426a8d0)) - -### Documentation -* **CHANGELOG:** Update release notes:repo ([`2fba5e5`](https://github.com/imAsparky/cookiecutter-py3-package/commit/2fba5e5a840efd90ba8a443b529398481a461b13)) - -### Build - -- version: - - Bump to version - 0.2.0. ([5eda4ea](https://github.com/imAsparky/cookiecutter-py3-package/commit/5eda4eabedb87b78fb188a9db6db40de912891b2)) - -### Feature - -- CHANGELOG: - - Add auto update opt to pkge #12 (#70) ([5e24e40](https://github.com/imAsparky/cookiecutter-py3-package/commit/5e24e403ecc39b64bbb963570bac7d1d2426a8d0)) ([#70](https://github.com/imAsparky/cookiecutter-py3-package/pull/70)) - -## [v0.1.1](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.1.1) - 2021-09-13 04:36:05 - -### Fix -* **version:** Update commit_subject #60 ([#68](https://github.com/imAsparky/cookiecutter-py3-package/issues/68)) ([`977acd1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/977acd12519ddf6c03800fd0d78edf93e7c54cb7)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`9d33ebc`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9d33ebc94a18177db6f00b003b4a05dfa3573190)) -* **CHANGELOG:** Update release notes:repo ([`7c5630e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/7c5630e982ab2482867e9a7777da624c55ecf576)) - -### Build - -- version: - - Bump to version - 0.1.1. ([23b10d1](https://github.com/imAsparky/cookiecutter-py3-package/commit/23b10d12f12cf462c2b949166b4b96b77247164f)) - -### Bug Fixes - -- version: - - Update commit_subject #60 (#68) ([977acd1](https://github.com/imAsparky/cookiecutter-py3-package/commit/977acd12519ddf6c03800fd0d78edf93e7c54cb7)) ([#68](https://github.com/imAsparky/cookiecutter-py3-package/pull/68)) - -## [v0.1.0](https://github.com/imAsparky/cookiecutter-py3-package/releases/tag/v0.1.0) - 2021-09-13 03:58:08 - -### Feature -* **package:** Add Conventional commits msg #15 ([#59](https://github.com/imAsparky/cookiecutter-py3-package/issues/59)) ([`9ce47dc`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9ce47dc73327bdb39d49e5e2074f1320e71d2285)) -* **pre-commit:** Add to pre-commit to GH #31 ([`bf25e6c`](https://github.com/imAsparky/cookiecutter-py3-package/commit/bf25e6cf327670a6e7a38e1464de74a25e447205)) -* **test:** Add GH action to test all contribs #10 ([`9f0787d`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9f0787d7403429186948a38e4b33a1ea8c66ab71)) -* **docs:** Add automatic changelog #8 ([`d14487a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/d14487aa3f3c190a1720884e1c875bdca055cb7d)) -* **docs:** Add automatic changelog #8 ([`0160b52`](https://github.com/imAsparky/cookiecutter-py3-package/commit/0160b52a0a623cc48c8400a5700b1a7460cb6812)) -* **quality:** Add code quality scan and badge #5 ([`fb8fe81`](https://github.com/imAsparky/cookiecutter-py3-package/commit/fb8fe81f4d9439e78a33b00babfa2ab3a7ae380b)) -* **git:** Add pre-commit and sane tests #3 ([`83a8804`](https://github.com/imAsparky/cookiecutter-py3-package/commit/83a88044bfb0ce44e54eb05943f2eb2c4282d195)) -* **git:** Add conventional commits template #2 ([`d808d8e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/d808d8ef08ca158f98bf5a302062f13ab503ab31)) -* **git:** Add additional issue templates #1 ([`6f5c9da`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f5c9da926b158d2116db2cee3f1bf3ac459c86b)) - -### Fix -* **version:** Add a pre-tested if: condition #60 ([#67](https://github.com/imAsparky/cookiecutter-py3-package/issues/67)) ([`d227bea`](https://github.com/imAsparky/cookiecutter-py3-package/commit/d227bea0eca9b5239438ff61491c2559f6b440c0)) -* **version:** Del manual job & fix concurrency #60 ([#66](https://github.com/imAsparky/cookiecutter-py3-package/issues/66)) ([`6e1c1ca`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6e1c1cadbe20755efb1911768343e6050a293469)) -* **version:** Change to chk_bld_stat false #60 ([#63](https://github.com/imAsparky/cookiecutter-py3-package/issues/63)) ([`cc63fa9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/cc63fa996a00e52c4c91ffcc55eb3056fe1c678f)) -* **version:** Change to python-semantic-release #60 ([#62](https://github.com/imAsparky/cookiecutter-py3-package/issues/62)) ([`83d8d06`](https://github.com/imAsparky/cookiecutter-py3-package/commit/83d8d06ef0f0bee22dc90e4abd32e26ba21bcba6)) -* **version:** Change to python-semantic-release #60 ([#61](https://github.com/imAsparky/cookiecutter-py3-package/issues/61)) ([`88c55f3`](https://github.com/imAsparky/cookiecutter-py3-package/commit/88c55f3755993a9a2a459d9ae367fa39b81fea50)) -* **pre-com:** Fix pre-commit errors #50 ([#51](https://github.com/imAsparky/cookiecutter-py3-package/issues/51)) ([`9360c7f`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9360c7fe47a3e79ae421c5e43ce330414203b2b1)) -* **CHANGELOG:** Fix tox.ini and conf.py #43 ([#47](https://github.com/imAsparky/cookiecutter-py3-package/issues/47)) ([`c7ead74`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7ead747409c6b1997e2524fefd261f7259d0274)) -* **git:** Comment out on:push:main #44 ([#45](https://github.com/imAsparky/cookiecutter-py3-package/issues/45)) ([`3631126`](https://github.com/imAsparky/cookiecutter-py3-package/commit/3631126832b3724859a2cfb58a834205c5948567)) -* **docs:** Add readthedocs.yaml config file #40 ([#42](https://github.com/imAsparky/cookiecutter-py3-package/issues/42)) ([`bc14391`](https://github.com/imAsparky/cookiecutter-py3-package/commit/bc14391f508c585aa8a29f00150c75e4823bc4a0)) -* **git:** Remove test for py3.10 #26 ([`e5fdef2`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e5fdef216b7adf4c0759d85fc2b90a733d2f4426)) - -### Documentation -* **CHANGELOG:** Update release notes:docs ([`04df834`](https://github.com/imAsparky/cookiecutter-py3-package/commit/04df834419874661dabbdf4b0add87c09ec6d7ef)) -* **CHANGELOG:** Update release notes:repo ([`47c5852`](https://github.com/imAsparky/cookiecutter-py3-package/commit/47c58522b907b3dc035c544168340175ea459886)) -* **CHANGELOG:** Update release notes:repo ([`6b06a18`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6b06a1819236469a904e1da3423a65a0e5900a1a)) -* **CHANGELOG:** Update release notes:docs ([`efe548a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/efe548ab884c2003d85fc32b1cc68214d9958080)) -* **CHANGELOG:** Update release notes:repo ([`26c68b1`](https://github.com/imAsparky/cookiecutter-py3-package/commit/26c68b1a81b782f656edcf120b3e2c47dec319cb)) -* **CHANGELOG:** Update release notes:docs ([`f1990bf`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f1990bf0f297e58c4afeb2d5f8a3dc62022b478f)) -* **CHANGELOG:** Update release notes:repo ([`ce3f5b9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/ce3f5b97dc0ab858c7171b7bf27a9a714ff8288f)) -* **codes:** Add code of conduct #56 ([#58](https://github.com/imAsparky/cookiecutter-py3-package/issues/58)) ([`b69c126`](https://github.com/imAsparky/cookiecutter-py3-package/commit/b69c1269178d77cee55983992b5a22737197d8b9)) -* **README:** Add pre-commit badge #54 ([#55](https://github.com/imAsparky/cookiecutter-py3-package/issues/55)) ([`08450af`](https://github.com/imAsparky/cookiecutter-py3-package/commit/08450af653d7b175a0327f51e5aaac7643f422c0)) -* **tutorial:** Fix broken pypi checklist link #37 ([#53](https://github.com/imAsparky/cookiecutter-py3-package/issues/53)) ([`f6ec351`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f6ec3518368078b34d25293494b3332027ccb37b)) -* **CHANGELOG:** Update release notes:docs ([`1cd4d23`](https://github.com/imAsparky/cookiecutter-py3-package/commit/1cd4d235c661c393d06d8cb6dea59b0aa5c55488)) -* **CHANGELOG:** Update release notes:repo ([`5956b9e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5956b9ed0e09a5cc21c5827fad977a6c59eebc19)) -* **CHANGELOG:** Update release notes:docs ([`41d893e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/41d893ee4dbb49639f17ff09101fab2283c2cfd2)) -* **CHANGELOG:** Update release notes:repo ([`c76282b`](https://github.com/imAsparky/cookiecutter-py3-package/commit/c76282bf2af20497af9d7b2b744c976674d5a4fa)) -* **CHANGELOG:** Update release notes:docs ([`2a022bb`](https://github.com/imAsparky/cookiecutter-py3-package/commit/2a022bb05e0db8e017da0bfc048210bbc809351a)) -* **CHANGELOG:** Update release notes:repo ([`57511fd`](https://github.com/imAsparky/cookiecutter-py3-package/commit/57511fd370af355a902c7a488225fa1a11ba3da5)) -* **CHANGELOG:** Add to the documentation #43 ([#46](https://github.com/imAsparky/cookiecutter-py3-package/issues/46)) ([`4a4c643`](https://github.com/imAsparky/cookiecutter-py3-package/commit/4a4c6432c5fabee769119baa7b7c3a859ee53b4e)) -* **logo:** Create and add logo to README #38 ([#41](https://github.com/imAsparky/cookiecutter-py3-package/issues/41)) ([`0ca1adb`](https://github.com/imAsparky/cookiecutter-py3-package/commit/0ca1adb6181138de7b6ccf06fa5984d2c693a169)) -* **update:** Links->cookiecutter-py3-package #20 ([#39](https://github.com/imAsparky/cookiecutter-py3-package/issues/39)) ([`7522aa4`](https://github.com/imAsparky/cookiecutter-py3-package/commit/7522aa4014eda677ec28bbd8154906f69afa8811)) -* **CHANGELOG:** Update release notes:repo ([`3656632`](https://github.com/imAsparky/cookiecutter-py3-package/commit/365663217187b5145176a3a75c1fd71a2caba67f)) -* **structure:** Update to newer sphinx style #34 ([`6f76c4e`](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f76c4ead0bb70be7f9630a0fb12ab8f6297bf7d)) -* **CHANGELOG:** Update release notes:repo ([`4eac58b`](https://github.com/imAsparky/cookiecutter-py3-package/commit/4eac58b18a5f2621bc0c5e671568d77dcade4485)) -* **README:** Add to list of notable changes ([#24](https://github.com/imAsparky/cookiecutter-py3-package/issues/24)) ([`5db0139`](https://github.com/imAsparky/cookiecutter-py3-package/commit/5db0139e3c21190b3d2085d3c4947beeac2fea25)) -* **CHANGELOG:** Update release notes:repo ([`eef147a`](https://github.com/imAsparky/cookiecutter-py3-package/commit/eef147a18740dfa10bdde71455420be74dcc7a6c)) -* **fork:** Update to indicate this fork #20 ([`f287b06`](https://github.com/imAsparky/cookiecutter-py3-package/commit/f287b06c8bf40262728bfe2dfe5d542200d0b2ba)) -* **CHANGELOG:** Update release notes:repo ([`9cf4777`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9cf477705b51d9f3490daee26198b1ec859f6cbc)) -* **README:** Remove support for Travis CI #18 ([`0dd88fa`](https://github.com/imAsparky/cookiecutter-py3-package/commit/0dd88fa56d5646caddd54828a2640fa96379d0af)) -* **CHANGELOG:** Update release notes:repo ([`9334b47`](https://github.com/imAsparky/cookiecutter-py3-package/commit/9334b472977b55eea4eb581b4668b82efec6f4eb)) -* **CHANGELOG:** Update release notes:repo ([`cd1f5d9`](https://github.com/imAsparky/cookiecutter-py3-package/commit/cd1f5d967a4422c39b7e1db2f69c9b4d288ab7b3)) -* **CHANGELOG:** Update release notes:repo ([`1dfd294`](https://github.com/imAsparky/cookiecutter-py3-package/commit/1dfd294d6b45a7f4a4be5e75b9b1565a70089a09)) -* **CHANGELOG:** Update release notes:repo ([`77a0834`](https://github.com/imAsparky/cookiecutter-py3-package/commit/77a0834945d67dad7ec7c219d5ead01b7d3e774d)) -* **CHANGELOG:** Update release notes:repo ([`e8207b3`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e8207b3325d307af5303d0e5deef82d005833acf)) -* **README:** Update to reflect this fork #4 ([`e592c57`](https://github.com/imAsparky/cookiecutter-py3-package/commit/e592c5750e36aff5b8486e0324e8778510498d7c)) - -### Build - -- version: - - Bump to version-0.1.0. ([dbcbc2f](https://github.com/imAsparky/cookiecutter-py3-package/commit/dbcbc2f5eb46b3751aedc2781097aa591f0f5eac)) - -### Chore - -- version: - - Add workflow_dispatch #60 (#64) ([1df725e](https://github.com/imAsparky/cookiecutter-py3-package/commit/1df725ed6073cf5e690f8b70749a30baede92dd1)) ([#64](https://github.com/imAsparky/cookiecutter-py3-package/pull/64)) - -- pre-commit: - - Weekly pre-commit autoupdate (#52) ([1cec5ce](https://github.com/imAsparky/cookiecutter-py3-package/commit/1cec5ce9c4db54a2945690906ead6a3f4fd1f420)) ([#52](https://github.com/imAsparky/cookiecutter-py3-package/pull/52)) - -- git: - - Add vscode workspace folder .gitignore ([c000227](https://github.com/imAsparky/cookiecutter-py3-package/commit/c00022746f83c123ec441bdd010fdd06e8f34b58)) - - Add project folders to .gitignore ([4847e57](https://github.com/imAsparky/cookiecutter-py3-package/commit/4847e574c6b978a3aab14313b12a74d1c879dcd6)) - -- setup: - - Update to setuptools #27 ([c0d3b0d](https://github.com/imAsparky/cookiecutter-py3-package/commit/c0d3b0dc18a58a947a2d9eea5123a31ae39e843c)) ([#33](https://github.com/imAsparky/cookiecutter-py3-package/pull/33)) - -- Travis: - - Remove support for Travis #18 ([ade1959](https://github.com/imAsparky/cookiecutter-py3-package/commit/ade1959381459abb179df2b3a7c1e25ae695f3db)) ([#23](https://github.com/imAsparky/cookiecutter-py3-package/pull/23)) - - Remove support #18 ([aa463f4](https://github.com/imAsparky/cookiecutter-py3-package/commit/aa463f412f26a03a9c1cc278b9bca56e54f114a2)) ([#21](https://github.com/imAsparky/cookiecutter-py3-package/pull/21)) - -- README: - - Remove stale Similar Templates #11 ([2b62df5](https://github.com/imAsparky/cookiecutter-py3-package/commit/2b62df5f7cf28f6b10fcc17ecebc6dec6dd550e2)) - -- docs: - - Comment on:push out for CHANGELOG ([ce7b075](https://github.com/imAsparky/cookiecutter-py3-package/commit/ce7b075187b060ca036e34a65f7f8e52a4ab1f0d)) - -- test: - - Rename workflow #10 ([d4a709b](https://github.com/imAsparky/cookiecutter-py3-package/commit/d4a709bcc6f8a431363b1837c3e78a6718f0ec44)) - - Fix typo in jobs:name: #10 ([38f6a89](https://github.com/imAsparky/cookiecutter-py3-package/commit/38f6a89d02b3512f143b6e74b775b8cdbaa2882a)) - - Add test coverage Py39 Py3-10 #7 ([a7a9219](https://github.com/imAsparky/cookiecutter-py3-package/commit/a7a921961c2d439ac0724fc539249520f73c6c72)) - -### Documentation - -- codes: - - Add code of conduct #56 (#58) ([b69c126](https://github.com/imAsparky/cookiecutter-py3-package/commit/b69c1269178d77cee55983992b5a22737197d8b9)) ([#58](https://github.com/imAsparky/cookiecutter-py3-package/pull/58)) - -- README: - - Add pre-commit badge #54 (#55) ([08450af](https://github.com/imAsparky/cookiecutter-py3-package/commit/08450af653d7b175a0327f51e5aaac7643f422c0)) ([#55](https://github.com/imAsparky/cookiecutter-py3-package/pull/55)) - - Add to list of notable changes (#24) ([5db0139](https://github.com/imAsparky/cookiecutter-py3-package/commit/5db0139e3c21190b3d2085d3c4947beeac2fea25)) ([#24](https://github.com/imAsparky/cookiecutter-py3-package/pull/24)) - - Remove support for Travis CI #18 ([0dd88fa](https://github.com/imAsparky/cookiecutter-py3-package/commit/0dd88fa56d5646caddd54828a2640fa96379d0af)) - - Update to reflect this fork #4 ([e592c57](https://github.com/imAsparky/cookiecutter-py3-package/commit/e592c5750e36aff5b8486e0324e8778510498d7c)) - -- tutorial: - - Fix broken pypi checklist link #37 (#53) ([f6ec351](https://github.com/imAsparky/cookiecutter-py3-package/commit/f6ec3518368078b34d25293494b3332027ccb37b)) ([#53](https://github.com/imAsparky/cookiecutter-py3-package/pull/53)) - -- logo: - - Create and add logo to README #38 (#41) ([0ca1adb](https://github.com/imAsparky/cookiecutter-py3-package/commit/0ca1adb6181138de7b6ccf06fa5984d2c693a169)) ([#41](https://github.com/imAsparky/cookiecutter-py3-package/pull/41)) - -- update: - - Links->cookiecutter-py3-package #20 (#39) ([7522aa4](https://github.com/imAsparky/cookiecutter-py3-package/commit/7522aa4014eda677ec28bbd8154906f69afa8811)) ([#39](https://github.com/imAsparky/cookiecutter-py3-package/pull/39)) - -- structure: - - Update to newer sphinx style #34 ([6f76c4e](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f76c4ead0bb70be7f9630a0fb12ab8f6297bf7d)) ([#35](https://github.com/imAsparky/cookiecutter-py3-package/pull/35)) - -- fork: - - Update to indicate this fork #20 ([f287b06](https://github.com/imAsparky/cookiecutter-py3-package/commit/f287b06c8bf40262728bfe2dfe5d542200d0b2ba)) - -### Feature - -- package: - - Add Conventional commits msg #15 (#59) ([9ce47dc](https://github.com/imAsparky/cookiecutter-py3-package/commit/9ce47dc73327bdb39d49e5e2074f1320e71d2285)) ([#59](https://github.com/imAsparky/cookiecutter-py3-package/pull/59)) - -- pre-commit: - - Add to pre-commit to GH #31 ([bf25e6c](https://github.com/imAsparky/cookiecutter-py3-package/commit/bf25e6cf327670a6e7a38e1464de74a25e447205)) ([#32](https://github.com/imAsparky/cookiecutter-py3-package/pull/32)) - -- test: - - Add GH action to test all contribs #10 ([9f0787d](https://github.com/imAsparky/cookiecutter-py3-package/commit/9f0787d7403429186948a38e4b33a1ea8c66ab71)) - -- docs: - - Add automatic changelog #8 ([d14487a](https://github.com/imAsparky/cookiecutter-py3-package/commit/d14487aa3f3c190a1720884e1c875bdca055cb7d)) - - Add automatic changelog #8 ([0160b52](https://github.com/imAsparky/cookiecutter-py3-package/commit/0160b52a0a623cc48c8400a5700b1a7460cb6812)) - -- quality: - - Add code quality scan and badge #5 ([fb8fe81](https://github.com/imAsparky/cookiecutter-py3-package/commit/fb8fe81f4d9439e78a33b00babfa2ab3a7ae380b)) - -- git: - - Add pre-commit and sane tests #3 ([83a8804](https://github.com/imAsparky/cookiecutter-py3-package/commit/83a88044bfb0ce44e54eb05943f2eb2c4282d195)) - - Add conventional commits template #2 ([d808d8e](https://github.com/imAsparky/cookiecutter-py3-package/commit/d808d8ef08ca158f98bf5a302062f13ab503ab31)) - - Add additional issue templates #1 ([6f5c9da](https://github.com/imAsparky/cookiecutter-py3-package/commit/6f5c9da926b158d2116db2cee3f1bf3ac459c86b)) - -### Bug Fixes - -- version: - - Add a pre-tested if: condition #60 (#67) ([d227bea](https://github.com/imAsparky/cookiecutter-py3-package/commit/d227bea0eca9b5239438ff61491c2559f6b440c0)) ([#67](https://github.com/imAsparky/cookiecutter-py3-package/pull/67)) - - Del manual job & fix concurrency #60 (#66) ([6e1c1ca](https://github.com/imAsparky/cookiecutter-py3-package/commit/6e1c1cadbe20755efb1911768343e6050a293469)) ([#66](https://github.com/imAsparky/cookiecutter-py3-package/pull/66)) - - change to chk_bld_stat false #60 (#63) ([cc63fa9](https://github.com/imAsparky/cookiecutter-py3-package/commit/cc63fa996a00e52c4c91ffcc55eb3056fe1c678f)) ([#63](https://github.com/imAsparky/cookiecutter-py3-package/pull/63)) - - Change to python-semantic-release #60 (#62) ([83d8d06](https://github.com/imAsparky/cookiecutter-py3-package/commit/83d8d06ef0f0bee22dc90e4abd32e26ba21bcba6)) ([#62](https://github.com/imAsparky/cookiecutter-py3-package/pull/62)) - - Change to python-semantic-release #60 (#61) ([88c55f3](https://github.com/imAsparky/cookiecutter-py3-package/commit/88c55f3755993a9a2a459d9ae367fa39b81fea50)) ([#61](https://github.com/imAsparky/cookiecutter-py3-package/pull/61)) - -- pre-com: - - Fix pre-commit errors #50 (#51) ([9360c7f](https://github.com/imAsparky/cookiecutter-py3-package/commit/9360c7fe47a3e79ae421c5e43ce330414203b2b1)) ([#51](https://github.com/imAsparky/cookiecutter-py3-package/pull/51)) - -- CHANGELOG: - - Fix tox.ini and conf.py #43 (#47) ([c7ead74](https://github.com/imAsparky/cookiecutter-py3-package/commit/c7ead747409c6b1997e2524fefd261f7259d0274)) ([#47](https://github.com/imAsparky/cookiecutter-py3-package/pull/47)) - -- git: - - Comment out on:push:main #44 (#45) ([3631126](https://github.com/imAsparky/cookiecutter-py3-package/commit/3631126832b3724859a2cfb58a834205c5948567)) ([#45](https://github.com/imAsparky/cookiecutter-py3-package/pull/45)) - - Remove test for py3.10 #26 ([e5fdef2](https://github.com/imAsparky/cookiecutter-py3-package/commit/e5fdef216b7adf4c0759d85fc2b90a733d2f4426)) - -- docs: - - Add readthedocs.yaml config file #40 (#42) ([bc14391](https://github.com/imAsparky/cookiecutter-py3-package/commit/bc14391f508c585aa8a29f00150c75e4823bc4a0)) ([#42](https://github.com/imAsparky/cookiecutter-py3-package/pull/42)) - -\* *This CHANGELOG was automatically generated by [auto-generate-changelog](https://github.com/BobAnkh/auto-generate-changelog)* diff --git a/docs/source/reference/reference-project-inputs.rst b/docs/source/reference/reference-project-inputs.rst index dae3098..ca8522d 100644 --- a/docs/source/reference/reference-project-inputs.rst +++ b/docs/source/reference/reference-project-inputs.rst @@ -69,6 +69,13 @@ Options The following package configuration options set up different features for your project. +**use_repo_status_badge** + *default = no* + + Whether to include a `Repo Status `_ badge. + + Options: ['no', 'concept', 'wip', 'active'] + **add_pyup_badge** *default = n* diff --git a/requirements_dev.txt b/requirements_dev.txt index 95c9ff1..6a1e5c1 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -1,10 +1,10 @@ alabaster==0.7.12 -cookiecutter==1.4.0 +cookiecutter==1.7.3 furo==2021.8.11b42 myst-parser==0.15.2 pre-commit==2.14.1 pytest==5.3.1 -pytest-cookies==0.5.1 +pytest-cookies==0.6.1 pytest-cov==2.12.1 python-semantic-release==7.19.2 Sphinx==4.1.2 diff --git a/tests/test_bake_project.py b/tests/test_bake_project.py index 6eefda8..079c12d 100644 --- a/tests/test_bake_project.py +++ b/tests/test_bake_project.py @@ -121,6 +121,7 @@ def test_bake_with_defaults(cookies): assert "tox.ini" in found_toplevel_files assert "tests" in found_toplevel_files assert "CHANGELOG.md" in found_toplevel_files + assert "README.rst" in found_toplevel_files assert "LICENSE" in found_toplevel_files assert "AUTHORS.rst" in found_toplevel_files assert "History.rst" not in found_toplevel_files @@ -400,18 +401,22 @@ def test_bake_with_repo_automatic_testing_suite(cookies): assert "test_contribution.yaml" in test_workflow_with_files -def test_bake_without_repo_automatic_testing_suite(cookies): - """ - Test cookiecutter created the package without repo automatic testing. - """ +def test_baked_readme_with_repo_status_badge(cookies): + """Test README file has a repo status badge generated.""" with bake_in_temp_dir( - cookies, extra_context={"create_repo_auto_test_workflow": "n"} + cookies, extra_context={"use_repo_status_badge": "concept"} ) as result: - test_workflow_without_files = [ - f.basename for f in result.project.join(".github/workflows").listdir() - ] - assert "test_contribution.yaml" not in test_workflow_without_files + assert "concept" in result.project.join("README.rst").read() + + +def test_baked_readme_without_repo_status_badge(cookies): + """Test README file has no repo status badge generated.""" + with bake_in_temp_dir( + cookies, extra_context={"use_repo_status_badge": "no"} + ) as result: + + assert "concept" not in result.project.join("README.rst").read() def test_bake_with_automatic_CHANGELOG(cookies): diff --git a/{{cookiecutter.git_project_name}}/README.rst b/{{cookiecutter.git_project_name}}/README.rst index 597caaf..4c7a582 100644 --- a/{{cookiecutter.git_project_name}}/README.rst +++ b/{{cookiecutter.git_project_name}}/README.rst @@ -3,28 +3,22 @@ {{ cookiecutter.project_name }} {% for _ in cookiecutter.project_name %}={% endfor %} -{% if is_open_source %} -.. image:: https://img.shields.io/pypi/v/{{ cookiecutter.git_project_name }}.svg - :target: https://pypi.python.org/pypi/{{ cookiecutter.git_project_name }} +{%- if cookiecutter.use_repo_status_badge != "n" %} +.. image:: https://www.repostatus.org/badges/latest/{{cookiecutter.use_repo_status_badge}}.svg + :target: https://www.repostatus.org/#{{cookiecutter.use_repo_status_badge}} + :alt: Project Status: {{cookiecutter.use_repo_status_badge}} +{%- endif %} -.. image:: https://readthedocs.org/projects/{{ cookiecutter.git_project_name }}/badge/?version=latest - :target: https://{{ cookiecutter.git_project_name }}.readthedocs.io/en/latest/?version=latest - :alt: Documentation Status +{%- if cookiecutter.add_pyup_badge == "y" %} +.. image:: https://pyup.io/repos/github/{{cookiecutter.github_username}}/{{cookiecutter.git_project_name}}/shield.svg + :target: https://pyup.io/repos/github/{{cookiecutter.github_username}}/{{cookiecutter.git_project_name}}/ + :alt: Updates {%- endif %} -{% if cookiecutter.add_pyup_badge == 'y' %} -.. image:: https://pyup.io/repos/github/{{ cookiecutter.github_username }}/{{ cookiecutter.git_project_name }}/shield.svg - :target: https://pyup.io/repos/github/{{ cookiecutter.github_username }}/{{ cookiecutter.git_project_name }}/ - :alt: Updates -{% endif %} {{ cookiecutter.project_short_description }} -{% if is_open_source %} -* Free software: {{ cookiecutter.open_source_license }} -* Documentation: https://{{ cookiecutter.git_project_name }}.readthedocs.io. -{% endif %} Features --------