Skip to main content

magcopy is a command-line utility that simplifies the copy and move operations of files and directories between terminal windows.

Project description

magcopy

magcopy is a command-line utility that simplifies the copy and move operations of files and directories between terminal windows. It allows users to copy from one terminal and paste into another with ease. The utility is designed to be used in a terminal environment and maintains its own clipboard for managing copied and moved items.

Installation

You can install magcopy using the following command:

pip install magcopy

Usage

magcopy <action> <path/file> [--help]

Actions

  • copy: Copy a folder or file to the clipboard.
  • move: Add a folder or file to the clipboard for moving.
  • paste: Paste a folder or file from the clipboard to the current folder or a specified folder.

Options

  • --help: Display the usage message.

Examples

magcopy copy /path/to/source/folder
magcopy paste /path/to/destination/folder

magcopy move /path/to/source/file
magcopy paste /path/to/destination/folder

Notes

  • This program does not alter the contents of the system's default clipboard. It maintains its own clipboard for managing copied and moved items.

Error Handling

In case of errors, the utility provides clear error messages to guide the user.

Testing

To run the tests for magcopy, you need to have pytest installed. If you don't have it installed, you can install it using the following command:

pip install pytest

Once pytest is installed, you can run the tests by executing the following command in the root directory of your project:

pytest

This will discover and run all the test files in your project. Make sure you have the required dependencies and a proper Python environment set up before running the tests.

Running Specific Tests

If you want to run tests from a specific file or directory, you can provide the file or directory path as an argument to pytest. For example:

pytest tests/test_clipboard.py

This command will run only the tests defined in the test_clipboard.py file.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions to magcopy are welcome! If you find a bug, have a feature request, or want to contribute in any other way, feel free to open an issue or submit a pull request. Your help is highly appreciated.

How to Contribute

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/magcopy.git
    
  3. Create a new branch for your contribution:

    git checkout -b feature/your-feature-name
    
  4. Make your changes and commit them with a descriptive commit message:

    git commit -m "Add your descriptive message here"
    
  5. Push your changes to your fork:

    git push origin feature/your-feature-name
    
  6. Open a pull request on the official magcopy repository.

Reporting Issues

If you encounter any issues or have suggestions, please open an issue on the GitHub issue tracker. Provide detailed information about the problem you're facing or the enhancement you're proposing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

magcopy-0.0.3.1.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

magcopy-0.0.3.1-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page