dlmv
is a TUI download manager for quickly choosing a destination
path near the working directory, or simple filesystem navigation.
Before you can install dlmv
, make sure you have the following prerequisites installed:
- Python (3.8+): Download and install from python.org or use your operating system's package manager.
- pip: Usually comes with Python. If not, follow the installation instructions.
- git: Download and install from git-scm.com.
Download the source code.
git clone https://github.com/KnoxSamuel/dlmv.git
cd dlmv
Install required dependencies.
pip install -r requirements.txt
Install the dlmv
package.
pip install .
After installation, dlmv
can be activated from anywhere on the filesystem.
Basic usage to open the TUI for filesystem navigation
dlmv
# if setuptools is giving you issues:
cd dlmv/
python3 src/dlmv/main.py
python3 src/dlmv/main.py --cloney <repo_url>
Clone a repository using the --cloney option
dlmv --cloney https://github.com/<username>/<repo_url>.git
Display help options
dlmv --help
Navigation:
('h / ←', "exit folder (cd ..)"),
('l / → / enter', "open folder (cd dir/)"),
('k/j / ↑/↓', "scroll up/down"),
('c', "clone here"),
('p', "custom path"),
('q', "quit")
Follow these steps to set up a development environment for dlmv.
Create a virtual environment.
python -m venv venv
Activate the virtual environment.
On Windows:
.\venv\Scripts\activate
On Unix or MacOS:
source venv/bin/activate
Install required dependencies.
pip install -r requirements.txt
Once the dev environment is set up, you can make changes to the codebase. Test your changes with:
python -m unittest discover tests
Build the executable by running:
python setup.py install
Ensure that the executable created can be invoked from the command line using the dlmv command.
For any issues during installation or setting up the development environment, check the GitHub issues tracker for similar problems or to add a new issue.
Contributions are most welcome! Please follow these guidelines:
- Fork the repository and create a new branch.
- Push proposed changes to your fork.
- Submit a pull request.
Or add a thread to the GitHub issues tracker.
This project is licensed under the MIT License - see the LICENSE.md file for details.
If you have any questions or suggestions regarding this project, feel free to contact me at [email protected].