Simple terminal helper program to save long terminal commands. See git: https://github.com/Zzanetiite/CommandSaver
Project description
CommandSaver
CommandSaver is a console-interface application that saves and executes terminal commands added by the user.
Summary
The purpose of the program is to help the user keep track of commonly used complicated commands. It is a lot like aliases.
Installation
Install the package in the user directory using:
pip install --user command-saver-terminal-program
Close the shell, start a new shell and use cs
to run.
If command not found error happens
Then check where it is installed:
pip show command-saver-terminal-program
Check whether the installation directory is included in the user's PATH. If not, modify your shell configuration file (e.g., ~/.bashrc or ~/.zshrc) to include it. For example, you can add the following line to your ~/.zshrc file:
export PATH="$PATH:~/.local/bin"
Running in the terminal
Use cs
to launch the program from bash or zsh.
Or run a single command using cs OPTION COMMAND_ID
Development
Project has been developed using PyCharm integrated development environment (IDE) and in accordance with the design of Software Engineering Fundamentals final assignment (University assignment).
Documentation
Read more about rich package here: https://rich.readthedocs.io/en/stable/tables.html
Read more about logger here: https://docs.python.org/3/library/logging.html
Read more about mock objects used for unit tests here: https://docs.python.org/3/library/unittest.mock.html?highlight=patch#module-unittest.mock
Additional details on the design and the project have been described in the Software Engineering Fundamentals final assignment.
Development
The code has a comment in almost every line, this was the coursework requirement.
Testing
Unit tests have been called them in the terminal using python. Tests have not been updated for CommandSaver versions >2.0 (outdated from 1.0 - didn't have time to do them).
Packaging & Deployment
Packaged using:
pip install setuptools wheel
python setup.py sdist bdist_wheel
Distributed via PyPI using twine:
pip install twine
twine upload dist/*
Locally tested using:
pip install --user dist/command-saver-terminal-program-2.1.10.tar.gz
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for command-saver-terminal-program-2.1.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | df1009e65045cf46a758901e8e14130af57aa04c00b2766d0e7e6edf8df5db82 |
|
MD5 | da7ab37856a80281aa53bfa7cc04cb48 |
|
BLAKE2b-256 | a803ac7d26c131f6732d60b235bc6deb88d046c4f992bcdf6188c3b3052d5bb6 |
Hashes for command_saver_terminal_program-2.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3baf60c467389a46325226039b5874cebf62f895110c1f828c84c57f20d87ea5 |
|
MD5 | 17ff1783ee8a7d1f18c30b90d0601ba0 |
|
BLAKE2b-256 | 1e3fcf0862754c7986e88246256773d37941b69ace015cc26d44c61aca15a42d |