A Python CLI script demo containing a little program to list files in a folder.
To run Alphabet FileList, you can use the filelist command. To see all available arguments you can use the -h flag:
$ filelist -hIf you want to investigate the command line arguments, then you can check out the cli.py file
If you have Python installed on your system, then you can install Alphabet FileList with pip. Open the terminal and run this command:
$ python -m pip install git+https://github.com/AlphabetType/list-filesYou can verify that the installation was succesful by running the filelist command in your terminal.
Clone this repository and navigate into the repository folder. After that, it's a good idea to create a virtual environment and activate it:
$ python -m venv venv/
$ source venv/bin/activate
(venv) $Make sure that you're in the root folder of the cloned repository. Then, you can install Alphabet FileList as an installable package with pip:
(venv) $ python -m pip install -e .You can verify that the installation was succesful by running the filelist command in your terminal.
To install all development requirements, run this command:
(venv) $ python -m pip install -r requirements.txtTo stick to the same code conventions of this Repo, please run black, isort, and flake8 before committing changes:
(venv) $ black . && isort . && flake8
With this command, black and isort will fix any formatting in the files of the current working directory and its subdirectories. After that, you may need to fix the errors that flake8 points out.