Merge branch 'main' into main-github

- setup git in CI
- keep CI with symlinks in place
  - maybe workaround is only needed on out gitlab runners

Author: jannismain

.bumpversion.cfg

@@ -0,0 +1,9 @@
+[bumpversion]
+current_version = 0.0.0
+message = bump v{current_version} -> v{new_version}
+commit = True
+tag = True
+
+[bumpversion:file:pyproject.toml]
+
+[bumpversion:file:.bumpversion.cfg]

.github/workflows/docs.yaml

@@ -23,7 +23,10 @@ jobs:
           python-version: "3.11"
       - uses: actions/configure-pages@v3
       - run: sudo apt-get update && sudo apt-get install tree
-      - run: python -m pip install -r requirements.txt
+      - run: | # creating example projects using copier requires a git identity
+          git config --global user.name "ci-runner"
+          git config --global user.email "ci-runner@github.com"
+      - run: python -m pip install .[doc]
       - run: make docs
       - uses: actions/upload-pages-artifact@v2
         with:

.vscode/cspell.json

@@ -9,8 +9,7 @@
     ".pre-commit-config.yaml",
     "mkdocs.yaml",
     "template",
-    "pyproject.toml",
-    "requirements.txt"
+    "pyproject.toml"
   ],
   "dictionaryDefinitions": [
     {

.vscode/terms.txt

@@ -1,12 +1,16 @@
 automodule
+BUILDDIR
 bumpversion
 conftest
 cyclomatic
 docstrings
+Docutils
 endfor
 Furo
 gitfile
 gitlab
+gitmoji
+glab
 includex
 jannismain
 jimustafa
@@ -19,12 +23,15 @@ noreport
 octicons
 pipenv
 pipx
+posargs
 precommit
 pymdownx
 pypa
 pyproject
 pytest
 sampleproject
+sendline
 setuptools
 SPHINXBUILD
+typer
 venv

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.0.1]
 
 Started this template by forking [pypa/sampleproject] and converting it to a copier template.
 
@@ -15,12 +15,11 @@ An example project (comparable to [pypa/sampleproject]) can be found at [jannism
 
 - CHANGELOG proposal from [jimustafa](https://github.com/jimustafa) in [!185](https://github.com/pypa/sampleproject/pull/185)
 - added `__main__` and `cli` modules (based on discussion of [!67](https://github.com/pypa/sampleproject/pull/67))
-  - the project script can now be executed additionally via `python -m sample`
-- Tooling
+- Refactored into copier template
     - add option to use `bumpversion`
     - add option to use `pre-commit`
-    - add option to choose between MkDocs and Sphinx documentation
-    - `remote` option ('github' (default), 'gitlab-fhg', 'gitlab-iis')
+    - add option to choose between documentation tools: `MkDocs` or `Sphinx`
+    - add `remote` option ('github' (default), 'gitlab-fhg', 'gitlab-iis')
         - if `gitlab-*` is selected, Gitlab CI configuration is added
         - if `github` is selected, GitHub actions are added
     - add Gitlab CI configuration to
@@ -31,7 +30,11 @@ An example project (comparable to [pypa/sampleproject]) can be found at [jannism
         - generate documentation and publish via [Gitlab Pages](https://docs.gitlab.com/ee/user/project/pages/)
     - add Github Actions configuration to
         - generate documentation and publish via [Github Pages](https://pages.github.com/)
-    - default branch option (default: main)
+    - add default branch option (default: `main`)
+- Documentation
+    - add user, reference and developer guides
+- `init_python_project` Package
+    - contains template + `init-python-project` command line interface
 
 ### Changed
 
@@ -44,7 +47,7 @@ An example project (comparable to [pypa/sampleproject]) can be found at [jannism
 
 <!-- [unreleased]: https://github.com/jannismain/python-project-template/compare/v0.0.2...HEAD -->
 <!-- [0.0.2]: https://github.com/jannismain/python-project-template/compare/v0.0.1...v0.0.2 -->
-<!-- [0.0.1]: https://github.com/jannismain/python-project-template/releases/tag/v0.0.1 -->
+[0.0.1]: https://github.com/jannismain/python-project-template/releases/tag/v0.0.1
 
 [pypa/sampleproject]: https://github.com/pypa/sampleproject
 [jannismain/python-project-template-example]: https://github.com/jannismain/python-project-template-example

Makefile

@@ -1,3 +1,7 @@
+.PHONY: install
+install: ## install all dependencies & development requirements
+	@pip install -e .[dev,test,doc]
+
 PUBLISHED_EXAMPLES = build/examples/github build/examples/gitlab_fhg build/examples/gitlab_iis build/examples/gitlab_iis_sphinx
 DOC_EXAMPLES = docs/examples/mkdocs docs/examples/sphinx docs/examples/default docs/examples/minimal docs/examples/full docs/examples/gitlab
 
@@ -102,6 +106,19 @@ test-all: ## run all tests
 	pytest ${PYTEST_ARGS}
 
 
+.PHONY: build install-build
+PKGNAME=init_python_project
+PKGDIR=src/${PKGNAME}
+BUILDDIR?=build/dist
+PYTHON?=python
+build: ## build package
+	@${PYTHON} -m pip install --upgrade build
+	@${PYTHON} -m build --outdir ${BUILDDIR} .
+install-build: build
+	@pip uninstall -y ${PKGNAME}
+	pip install --force-reinstall ${BUILDDIR}/*.whl
+
+
 .PHONY: help
 # a nice way to document Makefiles, found here: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
 help:

docs/_nav.md

@@ -7,7 +7,5 @@
     - user-guide/*
     - Topics
         - user-guide/topics/*
-    - [FAQ](user-guide/faq.md)
-- [Best Practices](./best-practice/)
 - [Reference](./reference/)
 - [Template Developer Guide](./developer-guide/)