Package: test-application
A Python Package to do random stuff.Features…​System RequirementsPython 3.7 / PyPy 3.7 or aboveInstallingThis package is available atPyPi.I recommend you to install usingpipx-
a tool that helps installing and running end-user applications written
in Python without worrying about any virtualenv magic:$ pipx install test_applicationBut you can of course also install it using normal pip or in your
virtual environment:$ python3 -m pip install test_applicationUsage$ test_application [--help]Extra: Run using DockerThis Project also offers a best-practiced Dockerfile to run this package
in an ensured-to-be-working environment:Details inREADME_DOCKER.📝 Development📌 Development Machine DependenciesPython 3.7 or greateror (optional)Docker📌 Development DependenciesDevelopment Dependencies are defined in apip requirements
filenamedrequirements-dev.txt. Example Installation Instructions for
Linux are shown below:# "optional": create a python virtualenv and activate it for the current shell session
$ python3 -m venv venv
$ source venv/bin/activate

$ python3 -m pip install -r requirements-dev.txt🧪 TestingAutomatic Tests are run on each Contribution using GitHub Workflows.To run the tests yourself, simply runtoxon the command line.🔢 VersioningVersions are defined usingTags.Versions must start withv.
When a new tag is pushed,https://github.com/{{cookiecutter.github_username }}/{{ cookiecutter.project_slug
}}/actions/workflows/release-to-pypi.yml[ a GitHub CI workflow]
()
takes care of building the wheels usingbuildand uploading them to PyPI
usingtwine.Version Bumps shall be made through the use ofbump2version, e.g.:$ bump2version patch
or
$ bump2version minor
or
$ bump2version majorThis tool automatically updates the version string in the required files
and creates a generic commit messsage with an appropiate tag (as
configured in.bumpversion.cf).After a new commit and tag has been created usingbump2versionand
pushed, it’s important not to forget to make an appropiate GitHub
Release for Changelog purposes.🍪 CookieCutterThis Project shall be kept in sync withthe CookieCutter it was
originally templated
fromusingcruft(if possible) or manual
alteration (if needed) to the best extend possible.🕗 ChangelogWhen a new tag is pushed, an appropriate GitHub Release will be created
by the Repository Maintainer to provide a proper human change log with a
title and description.ℹ️ General Linting and Styling ConventionsGeneral Linting and Styling Conventions areautomaticallyheld up
to
Standardsby variouspre-commithooks, at least to
some extend.Automatic Execution of pre-commit is done on each Contribution usingpre-commit.ci*. Pull
Requests even automatically get fixed by the same tool, at least by
hooks that automatically alter files.Not to confuse: Although some pre-commit hooks may be able to warn you
about script-analyzed flaws in syntax or even code to some extend (for
which reason pre-commit’s hooks arepart ofthe test suite),
pre-commit itself does not run any real Test Suites. For Information on
Testing, see🧪 Testing.Nevertheless, I recommend you to integrate pre-commit into your local
development workflow yourself.This can be done by cd’ing into the directory of your cloned project and
runningpre-commit install. Doing so will make git run pre-commit
checks on every commit you make, aborting the commit themselves if a
hook alarm’ed.You can also, for example, execute pre-commit’s hooks at any time by
runningpre-commit run --all-files.💪 ContributingThe following sections are generic in nature and are used to help new
contributors. The actual "Development Documentation" of this project is
found under📝 Development.🤝 PreambleFirst off, thank you for considering contributing to this Project.Following these guidelines helps to communicate that you respect the
time of the developers managing and developing this open source project.
In return, they should reciprocate that respect in addressing your
issue, assessing changes, and helping you finalize your pull requests.🍪 CookieCutterThis Project owns many of its files tothe CookieCutter it was
originally templated
from.Please check if the edit you have in mind is actually applicable to the
template and if so make an appropriate change there instead. Your change
may also be applicable partly to the template as well as partly to
something specific to this project, in which case you would be creating
multiple PRs.💬 Conventional CommitsA casual contributor does not have to worry about followingthe
specby definition, as
pull requests are being squash merged into one commit in the project.
Only core contributors, i.e. those with rights to push to this project’s
branches, must follow it (e.g. to allow for automatic version
determination and changelog generation to work).🚀 Getting StartedContributions are made to this repo via Issues and Pull Requests (PRs).
A few general guidelines that cover both:Search for existing Issues and PRs before creating your own.If you’ve never contributed before, seethe first timer’s guide on
Auth0’s
blogfor resources and tips on how to get started.IssuesIssues should be used to report problems, request a new feature, or to
discuss potential changesbeforea PR is created. When youcreate
a new
Issue,
a template will be loaded that will guide you through collecting and
providing the information we need to investigate.If you find an Issue that addresses the problem you’re having, please
add your own reproduction information to the existing issuerather
than creating a new one. Adding areactioncan also help be indicating to our maintainers that a particular problem
is affecting more than just the reporter.Pull RequestsPRs to this Project are always welcome and can be a quick way to get
your fix or improvement slated for the next release.In
general,
PRs should:Only fix/add the functionality in questionORaddress
wide-spread whitespace/style issues, not both.Add unit or integration tests for fixed or changed functionality (if
a test suite already exists).Address a single concernInclude documentationin the repoBe accompanied by a complete Pull Request template (loaded
automatically when a PR is created).For changes that address core functionality or would require breaking
changes (e.g. a major release), it’s best to open an Issue to discuss
your proposal first.In general, we follow the "fork-and-pull" Git workflowFork the repository to your own Github accountClone the project to your machineCreate a branch locally with a succinct but descriptive nameCommit changes to the branchFollowing any formatting and testing guidelines specific to this
repoPush changes to your forkOpen a PR in our repository and follow the PR template so that we
can efficiently review the changes.🗒 ChangelogPlease refer to theRelease Page of this
Repositoryfor a human changelog of the correspondingTags (Versions) of this
Project.Note that this Project adheres to Semantic Versioning. Please report any
accidental breaking changes of a minor version update.⚖️ LicenseLICENSEMIT License

Copyright (c) 2022 Jonas Pammer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.