mhmdkanj / renamerename Goto Github PK

Complement the already existing unit tests with integration tests that basically test app.py, which includes:

• parsing of arguments
• behavior / actions on a real directory

A dev-requirements.txt file can include

• pytest
• pytest-mock

The docs should be adapted accordingly (in the Test section of the README)

def test_save_transformation_to_json(self, transformation_encoder, file_transformation, tmp_path, mocker):
    date_mocker = mocker.patch('renamerename.executor.encoder_decoder.datetime')
    date_mocker.now.strftime.return_value = "X"
    transformation_encoder.save_transformation_to_json(tmp_path, file_transformation)
    assert 1 == 1   
    mocker.resetall()

The call generated by the patched object is not returning the required value "X"

Add a section in the README on how to build the documentation -- via:

cd docs
make html

Upon committing an index.html file at the root, which redirects to the index file inside the html folder, the file disappears after changes had been merged from the main branch.

The linked docs on GitHub Pages are not up-to-date with the current README and package version from the main branch.

The components that are not yet 100% covered include:

• executor.py
• filetransformation.py
• handlers.py

Not only should the user be able to filter by regex, but also via file properties, including but not limited to:

• file size
• time of creation/modification
• alphabetical order
• etc.

Saving the filename transformations to file or reading them from file could:

• make it easier to undo a bulk rename execution
• execute renaming based on an input csv file with explicit transformations

Package the 'renamerename' module as a Python package which can be installed with pip.

Probably use flake8 or an auto-formatter for static Python code style compliance checks.

Possibly use Sphinx autodoc or the like to be able to serve a readthedocs kind of pages.

• autogenerate API reference
• review landing page and docs generated
• host the docs in GitHub Pages or readthedocs

Currently, a FileTransformation instance needs a list of filenames to initialize a name to name mapping.
This should be done in a separate (class method), meanwhile the constructor should initialize from a provided dict object.

Old commits contain my old email address - which is not attributed to GitHub.