Skip to main content

Valkyrie Tools

Project description

Valkyrie Tools

Tests Codecov

PyPI Python Version

Python Black Read the documentation at https://valkyrie-tools.readthedocs.io/

Downloads License

Installation

Install valkyrie-tools from the Python Package Index:

$ pip install valkyrie-tools

or

$ python3 -m pip install valkyrie-tools

Requirements

  • Python 3.8+

Usage

All of the command line tools are available under directly and should be available in your path after installation.

$ valkyrie

All commands were built with the intention of being used in a CI/CD pipeline. As such, they all have a --help flag that will print out the available options.

$ valkyrie --help

Commands

  • valkyrie: The main entrypoint for configuring the tools.
  • urlcheck: Check the aliveness of a URL.
  • ipcheck: Get information for an IP address. (WIP)
  • dnscheck: Get dns records for a domain/IP address. (WIP)
  • whobe: Get information for a domain/IP address. (WIP)

CLI

You can call valkyrie-tools from the command line like so:

$ valkyrie

Passing Input

All supported methods of passing input to the script are:

Text as argument:

$ myscript "abc"

Text from file:

$ myscript test.txt

Interactive mode:

$ myscript -I
$ myscript --interactive

Piped stdin input:

$ echo "abc" | myscript

Piped stdin input (alt):

$ myscript <<<"abc"

Input file:

$ myscript <myfile.txt

Process substitution by file descriptor:

$ myscript <(cat myfile.txt)

Import

You can import valkyrie-tools into your project and use it like so:

import valkyrie_tools

Scripts

urlcheck

Arguments:

$ urlcheck <url>

Example Usage:

$ urlcheck "https://google.com"
-> https://google.com
   HTTP/1.1 - 301 - Moved Permanently
>> https://www.google.com/
   HTTP/1.1 - 200 - OK

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, valkyrie-tools is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was built off of the sweat and tears of the the bad actors it was built to fight.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

valkyrie_tools-0.2.3.tar.gz (14.8 kB view hashes)

Uploaded Source

Built Distribution

valkyrie_tools-0.2.3-py3-none-any.whl (15.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page