Package: kuws
As of version 0.0.7 This project has been moved and renamed SWSDetails on the continued project can be found here:https://github.com/Descent098/swsKuws; Kieran's Useful Web ScriptsSome useful, and common web actions all packaged togetherQuick-startInstallationFrom PyPirunpip install kuwsorsudo pip3 install kuws.From sourceClone the github repo (https://github.com/Descent098/kuws)cd into the 'kuws' root directory (where setup.py is) and runpip install .orsudo pip3 install .You can validate it is installed properly by typingkuwsinto your terminal, the output should look like this:Kieran's Useful Web Scripts; A set of python web utility scripts.Usage:kuws [-h] [-v]kuws redirects <url> [-t]kuws youtube <url> [<path>]kuws ssl <hostname> [-e] [-c]Options:-h --help               Show this help message and exit-v --version            Show program'sversionnumberandexit-e--expiryIfspecifiedwillchecktheexpiryofsslcert/domain-c--certIfspecifiedwillprintthefulldetailsoftheSSLcert-t--traceIfspecifiedwillshowthefulltraceoftheprovidedurlDocumentationUser Documentation can be found athttps://kuws.readthedocs.io.Development-Contribution guideInstalling development dependenciesThere are a few dependencies you will need to use this package fully, they are specified in the extras require parameter in setup.py but you can install them manually:nox   	# Used to run automated processes
pytest 	# Used to run the test code in the tests directory
mkdocs	# Used to create HTML versions of the markdown docs in the docs directoryJust go through and runpip install <name>orsudo pip3 install <name>. These dependencies will help you to automate documentation creation, testing, and build + distribution (through PyPi) automation.Folder StructureA Brief explanation of how the project is set up for people trying to get into developing for it/kuws/command_line_utility.pyThe main entrypoint for the kuws command./kuws/utilitiesContains all the core logic that is used by the main entrypoint./docsContains markdown source files to be used withmkdocsto create html/pdf documentation.**Before you can use this you will need to setup the mkdocs.yml file **/testsContains tests to be run before release**Before you can use this you will need to create tests, for more details take a look atpytest**Root Directorysetup.py: Contains all the configuration for installing the package via pip.LICENSE: This file contains the licensing information about the project.CHANGELOG.md: Used to create a changelog of features you add, bugs you fix etc. as you release.mkdocs.yml: Used to specify how to build documentation from the source markdown files.noxfile.py: Used to configure various automated processes usingnox, these include;Building release distributionsReleasing distributions on PyPiRunning test suite agains a number of python versions (3.5-current)If anything to do with deployment or releases is failing, this is likely the suspect.There are 4 main sessions built into the noxfile and they can be run usingnox -s <session name>i.e.nox -s test:build: Creates a source distribution, builds the markdown docs to html, and creates a universal wheel distribution for PyPi.release: First runs the build session, then asks you to confirm all the pre-release steps have been completed, then runstwineto upload to PyPitest: Runs the tests specified in /tests using pytest, and runs it on python versions 3.5-3.8 (assuming they are installed)docs: Serves the docs on a local http server so you can validate they have the content you want without having to fully build them..gitignore: A preconfigured gitignore file (info on .gitignore files can be found here:https://www.atlassian.com/git/tutorials/saving-changes/gitignore)ChangelogJanuary 28th 2020Merged V0.0.6 to master
- Added user documentation
- Fixed broken commands (all of them)
- Updated inline documentation
- Added tests (infastructure not actual tests... yet)
- Added nox to automate build and distribution processesOctober 20th 2019Merged V0.0.5 to master
- Reorganized modules
- Reformatted docstrings to numpy docstrings
- Refactored primary entrypoint to docopt from argparseJune 23rd 2019Merged v0.0.4 to master
- Added SSL argument to main parser
- refactored and updated inline documentation
- Added command line entrypoint to allow for direct calling
- Removed Youtube command for time being while pytube sorts out issuesApril 20th 2019Merged V0.0.3 to Master
Included:
- Better Packaging; Fixed Pip install pathing issuesApril 18th 2019Merged V0.0.2 to Master
Included:
- Better Packaging; can use functions via direct importing
i.e. from kuws import trace
Merged V0.0.1 To master
Included:
- Basic URL tracing
- Youtube video downloadingJanuary 7th 2019V0.0.1 initial commit on github