Metadata-Version: 2.1
Name: BatCave
Version: 37.1.1
Summary: Python Programming Toolkit
Home-page: https://gitlab.com/arisilon/batcave/
Author: Jeff Smith
Author-email: web@pobox.com
License: MIT
Keywords: python programming utilities
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Natural Language :: English
Requires-Python: >=3.6
Requires-Dist: docker (>=4.0)
Requires-Dist: GitPython (>=3.0)
Requires-Dist: google-cloud
Requires-Dist: kubernetes (>=10.0)
Requires-Dist: psutil (>=5.6)
Requires-Dist: requests (>=2.22)
Requires-Dist: WMI (>=1.4)
Requires-Dist: PyQt5 (>=5.13) ; platform_machine != "aarch64"
Requires-Dist: pywin32 (>=225) ; sys_platform == "win32"
Provides-Extra: dev
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: xmlrunner ; extra == 'dev'
Provides-Extra: test

BatCave Python Module
=====================
A useful collection of tools for writing Python programs.

Developing
----------
Development is best accomplished using pipenv where a virtual environment can be generated from the Pipfile using::

    pipenv install --dev

Building
--------
Building is performed by changing to the Build directory and running the build.py script which will perform two actions

1. run the unit tests and place the results in Build/unit_test_results/junit.xml
1. run the setup.py to create a PyPi distribution in Build/artifacts

Test Publish
------------
A test can be published to the PyPi test site with::

    build.py --test-publish

This will use twine to publish which will prompt for the username and password.
If you create a password with keyring you can specify the username on the command line with the "--user username" argument.
If you need to test publish with a new version number you can use the "--release number" argument

Publishing a Release
--------------------
After updating Changelog.rst A release can be published to PyPi with::

    build.py --publish


