Scripts and tools to streamline Business Analyst Quality Assurance testing.
1 - Clone this repo.
2 - Create an environment with the requirements.
> make env
3 - Explore - If you are more into Python, a good place to start is jupyter lab
from the root of the project, and look in the ./notebooks
directory. If GIS is more your schtick, open the project ./arcgis/ba-testing.aprx
.
Based on the pattern provided in the Cookiecutter Data Science template by Driven Data this template streamlines a number of commands using the make
command pattern.
-
make env
- builds the Conda environment with all the name and dependencies fromenvironment_dev.yml
and installs the local project packageba_testing
using the commandpython -m pip install -e ./src/src/ba_testing
so you can easily test against the package as you are developing it. -
make env_clone
- designed for environments using the default Conda instance installed with ArcGIS Pro. It is similar tomake env
, except this command clones thearcgispro-py3
environment. Otherwise, it still installs the packages listed inenvironment_dev.yml
and installs the local package usingpip
as described above. -
make docs
- builds Sphinx docs based on files in./docsrc/source
and places them in./docs
. This enables easy publishing in the master branch in GitHub. -
make test
- activates the environment created by themake env
ormake env_clone
and runs all the tests in the./testing
directory using PyTest. Alternately, if you prefer to use TOX for testing (my preference), there is atox.ini
file included as well. The dependencies (tox
andtox-conda
) for using TOX are included in the default requirements. By default, the TOX file creates an environment from theenvironment.yml
file using much fewer dependencies than the*_dev.yml
files.
Bump2Version is preconfigured based on hints from this article on Medium.
If you want to...
- apply a patch,
bumpversion patch
- update version with no breaking changes (minor version update),
bumpversion minor
- update version with breaking changes (major version update),
bumpversion major
- create a release (tagged in vesrion control - Git),
bumpversion --tag release
Project based on the cookiecutter GeoAI project template. This template, in turn, is simply an extension and light modification of the cookiecutter data science project template. #cookiecutterdatascience