Skip to content

Inconsistent naming #16

@paran1

Description

@paran1

The naming is of this software is somewhat inconsistent. Naming things is hard, but I think it would be a good idea to think a bit about what this software should be called and then do some renaming.

The repository is named softwareaccounting.git.

setup.py specifies name='sams-software-accounting'. So the prefix sams- is added and "software-accounting" gets a hyphen.

The defaults, documentation and examples use "softwareaccounting" (for example /var/spool/softwareaccounting) without sams and no hyphen. Except for the registrant which uses /var/spool/sgas-sa and /var/log/sgas-sa-registration.log.

The Python module is named sams and config files are installed to /etc/sams rather than /etc/sams-software-accounting.

There is another unrelated, and empty(!) sams package on PyPI. https://pypi.org/project/sams

The script file names starts with sams-, except for the registrant which is sgas-sa-registrant.
How this project relates to SGAS is not documented except for the link in extras/README.md

The sams- scripts are installed with a .py extension, the registrant is not.
I suggest dropping the extensions for aesthetic reasons.

The config files have names like sams-*.yaml which is somewhat redundant as they are already in /etc/sams.
The exception is the registrant that uses sgas-sa-registrant.conf.

This is not just me having OCD tendencies... The inconsistencies makes it a bit harder to build RPM packages, and also I have to remember which paths/names starts with sams-/sgas- and where hyphens are used.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions