onidemon37 / assault-cli

Tutorial into buildind a cli tool, using click and python

assault-cli

Tutorial into buildind a cli tool, using click and python

• Programming Use Cases with Python

requirements

setup.py (for humans)

This repo exists to provide an example setup.py file, that can be used to bootstrap your next Python project. It includes some advanced patterns and best practices for setup.py, as well as some commented–out nice–to–haves.

For example, this setup.py provides a $ python setup.py upload command, which creates a universal wheel (and sdist) and uploads your package to PyPi using Twine, without the need for an annoying setup.cfg file. It also creates/uploads a new git tag, automatically.

In short, setup.py files can be daunting to approach, when first starting out — even Guido has been heard saying, "everyone cargo cults thems". It's true — so, I want this repo to be the best place to copy–paste from :)

Check out the example!

• Installation cd assault-cli/

## Download the setup.py file:
## download with wget
wget https://raw.githubusercontent.com/navdeep-G/setup.py/master/setup.py -O setup.py

## download with curl
curl -O https://raw.githubusercontent.com/navdeep-G/setup.py/master/setup.py

• To Do Tests via $ setup.py test (if it's concise). Pull requests are encouraged!

• github-actions

• tox

• assault ** Usage

assault https://example.com
... Done!
--- Results ---
Successful requests   500
Slowest               0.010s
Fastest               0.001s
Average               0.003s
Total Time            0.620s
Requests Per Minute   4836
Requests Per Second   80

• doctests Usage

python -m doctest -v assault/stats.py

• https://docs.python.org/3/library/doctest.html

• Resources

• pep8
• click
• asyncio - Asynchronous I/O
• pre-commit
• setup.py
• doctest
• typing
• queue

** More Resources What is setup.py? on Stack Overflow Official Python Packaging User Guide The Hitchhiker's Guide to Packaging Cookiecutter template for a Python package