Package: pytemplates-pypackage
DescriptionA production ready python library templateMetadata and dependency information is stored in the pyproject.toml for compatibility with bothpipandpoetry.Flake8,pylint, andisortconfigurations are defined to be compatible with theblackautoformatter.Pylint settings are based on theGoogle Python Style Guideand adapted for black compatibility.Linting tools run automatically before each commit usingpre-commit, black, and isort.Test coverage reports are generated during every commit and pull request usingcoverageandpytest-cov. All reports are automatically uploaded and archived oncodecov.io.Unit tests are written usingpytestand static type checking is provided bymypy.Package releases toPyPIwith dynamic versioning provided bybump2versionbegin automatically whenever a new tag is created in github.Documentation is built usingmkdocsandmkdocstrings. Docs are automatically deployed togithub pagesduring every release.Release notes are automatically generated during every release usinggithub actions.Source code documentationInstallationTo install the package usingpip:pipinstallpytemplates_pypackageTo add the package as a dependency usingpoetry:poetryaddpytemplates_pypackageUsageFrom a.pyfile:importpytemplates_pypackageprint(pytemplates_pypackage.__version__)pytemplates_pypackage.greet(user="Jacob")frompytemplates_pypackageimportwish_farewellwish_farewell(user="Jacob")Developer SetupTo begin local development, clone thePyTemplates/typer_clirepository and use one of the following methods to build it. Commands should be executed from inside of the project home folder.Using poetrypoetryinstallInstall optional dependencies using the--extrasflag:poetryinstall--extras=environmentUsing pippipinstall.Install optional dependencies using square brackets:pipinstall.[environment]Environmentstest=["pytest","pytest-cov",]lint=["black","isort","flake8","pylint","mypy","pre-commit",]docs=["mkdocs","mkdocstrings","mkdocstrings-python","mkdocs-material",]# Includes all optional dependenciesdev=["pytest","pytest-cov","black","isort","flake8","pylint","mypy","pre-commit","mkdocs","mkdocstrings","mkdocstrings-python","mkdocs-material","bump2version",]Commandsmake clean- Remove all build, testing, and static documentation files.make test- Run the tests using pytest.make lint- Run the linting tools. Includes pre-commit hooks, black, isort, flake8, pylint, and mypy.make check- Run the test and lint commands.make gen-docs- Generate HTML documentation.make docs- Generate HTML documentation and serve it to the browser.make pre-release increment={major/minor/patch}- Bump the version and create a release tag. Should only be run from themainbranch. Passes the increment value to bump2version to create a new version number dynamically. The new version number will be added to_version_.pyandpyproject.tomland a new commit will be logged. The tag will be created from the new commit.Workflowstest- Run the tests on every push/pull_request to themainbranch. Writes a coverage report using pytest-cov and uploads it to codecov.io. Tests run against python versions 3.8 and 3.9. Optional manual trigger in the github actions tab.lint- Run the linting tools on every push/pull_request to themainbranch. Includes pre-commit hooks, black, isort, flake8, pylint, and mypy. Optional manual trigger in the github actions tab.docs- Build the documentation, publish to thedocsbranch, and release to github pages. Runs on a manual trigger in the github actions tab.release- Build a wheel distribution, build a docker image, create a github release, and publish to PyPI and Docker Hub whenever a new tag is created. Linting and testing steps must pass before the release steps can begin. Documentation is automatically published to thedocsbranch and hosted on github pages. All github release tags, docker image tags, and PyPI version numbers are in agreement with one another and follow semantic versioning standrads.ReleasesA release should consist of the following two steps from a tested, linted, and up to date copy of themainbranch:make pre-release increment={major/minor/patch}- Commit the version number bump and create a new tag locally. The version number follows semantic versioning standards (major.minor.patch) and the tag is the version number prepended with a 'v'.git push --follow-tags- Update themainbranch with only the changes from the version bump. Publish the new tag and kick off the release workflow.File Tree.
├──docs
│├──code_reference
││├──module1.md
││└──module2.md
│├──developer_guide
││├──commands.md
││├──developer_setup.md
││├──releases.md
││└──workflows.md
│├──extras
││├──credits.md
││└──file_tree.md
│├──index.md
│└──user_guide
│├──installation.md
│└──usage.md
├──LICENSE
├──Makefile
├──mkdocs.yml
├──poetry.lock
├──pyproject.toml
├──README.md
├──src
│└──pytemplates_pypackage
│├──core
││├──__init__.py
││├──module1.py
││└──module2.py
│├──__init__.py
│└──__version__.py
└──tests├──__init__.py├──test_module1.py└──test_module2.pyCreditsOther python package templateshttps://github.com/waynerv/cookiecutter-pypackagehttps://github.com/AllenCellModeling/cookiecutter-pypackageActionshttps://github.com/JamesIves/github-pages-deploy-actionhttps://github.com/softprops/action-gh-release