a pizzacutter default test project, crated with PizzaCutter and the PizzaCutter default python template
Project description
Version v1.0.2 as of 2022-05-20 see Changelog
This is the test project created using PizzaCutter
PizzaCutter is a command-line utility that creates and updates software projects in any language from PizzaCutter project templates.
The purpose of this repository is, to show and test a newly created project from the python default template.
- More Information can be found here :
more templates to come
automated tests, Travis Matrix, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)
Python version required: 3.6.0 or newer
tested on recent linux with python 3.6, 3.7, 3.8, 3.9, 3.10, pypy-3.8 - architectures: amd64
100% code coverage, flake8 style checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring
Try it Online
You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here
Usage
example for including docstrings
def main() -> None:
"""
the main method, prints hello world
Parameter
----------
none
none
Result
----------
none
Exceptions
----------
none
Examples
----------
>>> main()
Hello World - by PizzaCutter
"""
Usage from Commandline
Usage: pct_python_default_test [OPTIONS] COMMAND [ARGS]...
a pizzacutter default test project, crated with PizzaCutter and the
PizzaCutter default python template
Options:
--version Show the version and exit.
--traceback / --no-traceback return traceback information on cli
-h, --help Show this message and exit.
Commands:
info get program informations
Installation and Upgrade
Before You start, its highly recommended to update pip and setup tools:
python -m pip --upgrade pip
python -m pip --upgrade setuptools
to install the latest version from github via pip:
python -m pip install --upgrade git+https://github.com/bitranox/pct_python_default_test.git
include it into Your requirements.txt:
# Insert following line in Your requirements.txt:
# for the latest development version :
pct_python_default_test @ git+https://github.com/bitranox/pct_python_default_test.git
# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt
to install the latest development version from source code:
# cd ~
$ git clone https://github.com/bitranox/pct_python_default_test.git
$ cd pct_python_default_test
python setup.py install
via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.
# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/pct_python_default_test.git
$ cd pct_python_default_test
# to run the tests:
$ make test
# to install the package
$ make install
# to clean the package
$ make clean
# uninstall the package
$ make uninstall
Requirements
following modules will be automatically installed :
## Project Requirements
click
cli_exit_tools
Acknowledgements
special thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”
Contribute
I would love for you to fork and send me pull request for this project. - please Contribute
License
This software is licensed under the MIT license
—
Changelog
new MAJOR version for incompatible API changes,
new MINOR version for added functionality in a backwards compatible manner
new PATCH version for backwards compatible bug fixes
v1.0.2
2022-05-20: update github actions test matrix to python 3.10
v1.0.1
2022-03-29: remedy mypy Untyped decorator makes function “cli_info” untyped
v1.0.0
2022-03-25: remove listdir of ./dist, moved to lib_cicd_github
v0.1.1
2020-08-01: fix pypi deploy
v0.1.0
- 2020-07-31:
change1
change2
…
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for pct_python_default_test-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 821ed48a241188a895f8404272a9147c61f6cae0804dd298ab99ae25110ecf92 |
|
MD5 | 048eb23d08afe4d444e41f1f9065cc40 |
|
BLAKE2b-256 | bc34bddea955326c1a89c495670c22e3e6f43261d729a678147a3b85b0856e6e |
Hashes for pct_python_default_test-1.0.2-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ab157a2268a8cf75f521a169b19f5fab14d9f6b95c7be88a8f7a203c9cd2788 |
|
MD5 | 39c9ab8635c04f1974054ddddb7c75fb |
|
BLAKE2b-256 | 005acdb56bf6ac003a53f8f561581190e173bc6f852a4dc9bde1c3c1d4a0e346 |
Hashes for pct_python_default_test-1.0.2-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | dcf7892723d167cc8330517da7f021ca2a1a39620965bfab76f2fe4933cb67ab |
|
MD5 | 7c82b95b0b77831bae329e33a3dba8e8 |
|
BLAKE2b-256 | f891ae99f547b86bba4c8732aee1fe479c753d1e4134a0abf3072bc231a7ada2 |
Hashes for pct_python_default_test-1.0.2-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46ae99a195ba591e4b7d2cc65851e0d2f16fff116c57843497177ae508a49d1c |
|
MD5 | 258398bf5ce72ec3382f82486b55e7c3 |
|
BLAKE2b-256 | 77f22f4213c1ceb16287ce339c225a75e3a1635e0a89079a6f4e6c8470aff779 |
Hashes for pct_python_default_test-1.0.2-py3.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd56ddd10814ffd8b13ed28a4ce7700b2c494c1a49fb6ad4e72b3dea71b13be4 |
|
MD5 | 49b9a1c3682aeee15fd7b2ab1da4a5bf |
|
BLAKE2b-256 | 8c49a951af033bf588270bad87a552fe696286d195c8e899aae14f7717bba3c5 |
Hashes for pct_python_default_test-1.0.2-py3.6.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3fe60fc293b11a5bd68d33abbce2a84482dfa1277f75ec93289d58653843091 |
|
MD5 | 86d729b44d4c0b4195939c780f993564 |
|
BLAKE2b-256 | c21fffb1ba3ae9ff3793230c85747e98327e367da4276b56b8ae79fd86edb9cc |
Hashes for pct_python_default_test-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d1e080a09edb91f5f6508d91727247836eb69cb58d5fa529c082af71f3ec6a5 |
|
MD5 | 96125847fc06270e05527819630f4b43 |
|
BLAKE2b-256 | 38bec2e8fbbeba7f9cca1ff2a65dee4a2a1ef88e7c7baa5eeef002547f966230 |