Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement a basic __main__.py file able to process a --excavator arg. #5

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alexjeffburke
Copy link

This commit adds a basic argparse based package level main file which given a filename and a named excavator will perform an excavation and output the usual HTML files.

By default this uses the standard temporary path, but additionally support specifying -d and allow a directory argument of "." which will cause outputting output folder in the cwd: ./output/_autoarchaologist

In order to ensure things are working include tests of the new command line as well as the basic operation of excavating the example file. The tests check the expected HTML files were written for this known input and assert some basic properties of the excavated artifacts.

While here repair the example excavation. The excavation it executes is explicitly declared thus CLI selectable as --excavator examples.showcase

This commit adds a basic argparse based package level main file which
given a filename and a named excavator will perform an excavation and
output the usual HTML files.

By default this uses the standard temporary path, but additionally
support specifying -d and allow a directory argument of "." which will
cause outputting output folder in the cwd: ./output/_autoarchaologist

In order to ensure things are working include tests of the new command
line as well as the basic operation of excavating the example file. The
tests check the expected HTML files were written for this known input
and assert some basic properties of the excavated artifacts.

While here repair the example excavation. The excavation it executes is
explicitly declared thus CLI selectable as --excavator examples.showcase
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant