Skip to content

Reestructure the package files

There are two main issues with the current dccQuantities code:

1. Package files

The modules should be reestructured into a folder src/dcc_quantities. This will allow to pack all imports and organize them by the library name:

# This is the current import state
from dcc_name import DccName
from helpers import *

# This is how the organized imports should look after the change
from dcc_quantities import DccName
from dcc_quantities.dcc_name import DccName
from dcc_quantities.helpers import *

Many of these imports will actually affect at the code in the library right now, like this one, but it will also make the code more robust.

2. Dependencies

There are many dependencies listed, from which:

  • Some (like pandas) are only used within the tests. It is of no use to install these ones when the library is installed.
  • Some (like requests) are not being used at all within the package nor the tests.

As a solution for this point:

  1. Remove all unsused dependencies.
  2. Create a tests/requirements.txt file with all requirements needed only for the tests. Include here also the optional testing dependencies at the toml file.

This also requires the modification of the .gitlab-ci.yml to ensure the correct installation before running the tests.