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.
Development pre-requisites
Please see requirements.txt for any necessary packages.
Explanation of development
Project is developed using PyCharm integrated development environment (IDE) and in accordance with the design of Software Engineering Fundamentals final assignment.
How do I run this on my machine?
- Ensure requirements are installed.
- Use Pycharm or similar Python interpreter.
- Setup a path in bash or zsh to run it from terminal.
Documentation
For any additional details on the design and project see Software Engineering Fundamentals final assignment.
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
Development
This program has no dependencies, other than ones described in the requirements.txt file.
This program has a comment for almost every line of the code, this was a requirement for the coursework assignment.
Testing
To test unittests, call them in the terminal using python or use Python interpreter. Tests have not been updated for CommandSaver version 2.0 (outdated from 1.0 - didn't have the time to do them).
Running
To run the program use Python to open the cs.py file in the command_saver folder or call from the terminal.
Deploying
Run the program through terminal using cs OPTION COMMAND_ID
or via python calling the cs.py
.
Packaging
To package program with changes use:
pip install setuptools wheel
python setup.py sdist bdist_wheel
To distribute package use in IDE:
pip install twine
And afterwards, in the command prompt:
twine upload dist/*
To locally test the dist package:
pip install --user dist/command-saver-terminal-program-1.0.0.tar.gz
Installation via Pip
Use this command to install the package.
pip install command-saver-terminal-program
Use cs
to launch the program in the terminal.
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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c564a6e0cd21f077bbb30d7b101a54c97b66a21f5443eb8f2b3e937c74a018f |
|
MD5 | 28d23b96bad2e2e69fc01f184047e474 |
|
BLAKE2b-256 | b9f3b6c96f8312bd03a7bff949c7b3ccaf34b28061e88b6e3beb2af5b6d69969 |
Hashes for command_saver_terminal_program-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c31d46858d97d9cd84a60c1302329b8bd6f7d71073c1ae760be768519ee0e69b |
|
MD5 | adccaa2248c6a2b1282129698e76ac89 |
|
BLAKE2b-256 | 76c1cbcef45c4d02b22c196cf5ca9fdad4608d05971b1b9bd53b910746be80ae |