soc221b/namanager

A filename/dirname manager which could determine whether paths is expected and you could also automatically rename it.

namanager

A file or/and directory name manager which could determine names are/aren't expectable, and you could also automatically rename it.

Features

• Match or ignore particular files/directories.
• Supports checking of most common format of letter-cases (upper, lower, camel, and pascal-case).
• Supports checking of convention of word separators (underscore-to-dash/dash-to-underscore).

How to use?

Installation

• First of all check you already have pip installed, and then just type in:

pip install namanager

• Sometimes, you need to install on offline environments, hence that you could download wheel s from PyPI or by pip:

pip download namanager

After moved wheels (involve dependencies) into your env, you could manually install it by following commands:

pip install namanager-x.x.x-py2.py3-none-any.whl

Running

1. Configure your settings.json.
2. Run command

namanager

If the settings file doesn't existed in your current working directory or CWD:

namanager --settings /path/to/your/settings

namanager's Issues

Add a CLI tool

We need a CLI tool which can be run instead of python3 file_checker/main.py --settings settings.json.

There is some examples of big project:
nose

Add output management options

1. Use std logging module
2. Add difference levels for silent(not set), debug(debug), normal(error), and verbose(info).

Add helper for arguments for settings.json

Add documentation of using the namanager

1. Add examples for using the namanager.

Add pretty dump of Json, XML

1. Add CLI optional arguments for Json/XML dumps.

Add automatically rename files/directories feature

1. Automatically rename unexpected files/directories.
2. Add CLI arguments for this.
3. Add backup/recover option for 1.

Add cross-platform tests of CI

New feature list

Please add PR/commit to line end If the feature is done.

• Dump result to json file
• Check user-defined pair of word separator
• Add feature ignore prefix, suffix of name

Ignore hidden file, system file, etc.

1. User can change those setting in setting file.

NOTE:

1. Check that all function calls must be independent.
2. Prefix dots are used to hidden files in unix-like systems, so please add more tests for rename.

Add redirect of dumps

1. Add CLI optional arguments, e.g, --to-file=FILENAME.

Known bugs.

If exists a directory's name is the same as its parent directory's name, we need to rename twice (according to how many layer is same).