Adding project.maintenance

[max-hassani]

Introduces Maintenance class, which returns get_database_statistics as an attribute of a pyiron project. Of course, the maintenance class can be further extended to include other performance measures, like disk spaces, available memory, etc.

The use case is:

from pyiron_base import Project
pr = Project()
pr.maintenance.database_statistics

this returns a dataframe including measure about postgres database statistics.

[jan-janssen]

Is not it sufficient to import directly? like:

from pyiron_base import get_database_statistics
get_database_statistics()

I do not see why the database statistics are related to a specific project.

[max-hassani]

Is not it sufficient to import directly? like:

from pyiron_base import get_database_statistics
get_database_statistics()

I do not see why the database statistics are related to a specific project.

I agree! But Jörg required it yesterday in the technical meeting. I believe, he had the idea that the maintenance class can be extended to include more performance measures later on.

[jan-janssen]

But then at least keep the same function name, rather than making it a property:

from pyiron_base import Project
pr = Project()
pr.maintenance.get_database_statistics()

[niklassiemer]

Is not it sufficient to import directly? like:

from pyiron_base import get_database_statistics
get_database_statistics()

I do not see why the database statistics are related to a specific project.

I agree! But Jörg required it yesterday in the technical meeting. I believe, he had the idea that the maintenance class can be extended to include more performance measures later on.

Yes, I raised the same argument that the database statistics is not related to a specific project. However, he really wants to be able to do everything with one import statement

from pyiron{_module} import Project

Therefore, also #385.

[max-hassani]

But then at least keep the same function name, rather than making it a property:

from pyiron_base import Project
pr = Project()
pr.maintenance.get_database_statistics()

Now, it is implemented as you suggested.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[max-hassani]

@niklassiemer, the reason that I chose self.global_status was because global is a keyword in python. Since the tests are failing too, I will revert it to global_status.

[niklassiemer]

Sure, I never used the global and looking at this, I think I never will...

[max-hassani]

@niklassiemer, if you agree, we can merge this.
I will open another pull request to include a unittest and improve the coverage. Currently, I do not know exactly if a mocked up database connection is sufficient, which I doubt, or a running postgress database via github workflows is necessary. I have to learn more about it.