search

alphagov / cybersecuritytools

1 stars 2 forks source link

Add hec_index_checker #2

Closed akinnane closed 3 years ago

akinnane commented 3 years ago

Can you add something to the README to explain what this repo is for and what's in it?

Yes, briefly though - this is going to become our single repo for all of our python code.

If cst.py is a click cli should it be called cli.py?

I went back and forth a few times between the two names. The runnable artefact from this is called cst(maybe needs a better name) but I eventually settled on calling this file the same as the script name. I found it confusing when the command was cst but the file is cli.py. I'm not 100% convinced about either thought so we can discuss this offline.

I liked tox but we moved away from it - why has this gone back to tox?

I like tox too. Specifically I like that it lets us test against multiple python versions and as this library will be included in many projects we will need to run the tests against all the python versions we use.

danjoneslf commented 3 years ago

The runnable artefact from this is called cst

What do you mean - runnable artefact? I'm assuming you run python cst.py check-hec-token --blah. Are you saying we'd package that up into an executable somehow so you run cst check-hec-token --blah?

akinnane commented 3 years ago

Ideally, yes. That way we can have a single command to install that would give us access to useful entrypoints and functions in the code. Hopefully that would make developing, CI, and debugging much easier to work with.

akinnane commented 3 years ago

Yes, we will need some sort of structure. As I move more code into this repo I'm hoping that will develop in the right way. If not we can reorganise.