search

blackducksoftware / hub-rest-api-python

HUB REST API Python bindings
Apache License 2.0
89 stars 104 forks source link

example folder needs clean up as there are scripts which do not follow the location guidelines. #238

Open koshmack opened 1 year ago

koshmack commented 1 year ago

I will create clean up commit later to move scripts which are supposed to be placed under ./examples/client with instructive README

OffBy0x01 commented 1 year ago

I was also thinking of doing something similar but it wasn't always easy to draw the line between the two - IIRC some of the 'examples' don't use either of the interfaces.

Perhaps we should use something like /examples/scripts for all maintained scripts, /examples/client for demo/ true examples and /examples/deprecated-hubinstance for everything else?

koshmack commented 1 year ago

Agree with the ideas for holding the scripts which are using Client class in /examples/client and other ones which are using HubInstance class in /examples/deprecated-hubinstance. What other scripts are suggested to move to /examples/scripts? Maybe scripts which are using neither Client nor HubInstance? Besides that, it sounds like difficult to me to draw the line between 'maintained' and 'not maintained' apart form the used hub classes (Client or HubInstance).

OffBy0x01 commented 1 year ago

As you say, not maintained is essentially anything using HubInstance.

I think ideally the base /examples directory should only contain the folders:

Everything else that is currently there can be classified under one of these.