# 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:
```bash
pip install magcopy
```
## Usage
```bash
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
```bash
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:
```bash
pip install pytest
```
Once `pytest` is installed, you can run the tests by executing the following command in the root directory of your project:
```bash
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:
```bash
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](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:
```bash
git clone https://github.com/your-username/magcopy.git
```
3. Create a new branch for your contribution:
```bash
git checkout -b feature/your-feature-name
```
4. Make your changes and commit them with a descriptive commit message:
```bash
git commit -m "Add your descriptive message here"
```
5. Push your changes to your fork:
```bash
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](https://github.com/your-username/magcopy/issues). Provide detailed information about the problem you're facing or the enhancement you're proposing.
Raw data
{
"_id": null,
"home_page": "",
"name": "magcopy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "file management,command-line utility,clipboard,copy and move,terminal interaction",
"author": "",
"author_email": "Ada\u00edas Magdiel <eu@adaiasmagdiel.com>",
"download_url": "https://files.pythonhosted.org/packages/b8/22/c7bc38e571a11957026566294d56413180607c7811efa49d0dba9b1cac53/magcopy-0.0.3.1.tar.gz",
"platform": null,
"description": "# magcopy\r\n\r\n`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.\r\n\r\n## Installation\r\n\r\nYou can install `magcopy` using the following command:\r\n\r\n```bash\r\npip install magcopy\r\n```\r\n\r\n## Usage\r\n\r\n```bash\r\nmagcopy <action> <path/file> [--help]\r\n```\r\n\r\n### Actions\r\n\r\n- **copy**: Copy a folder or file to the clipboard.\r\n- **move**: Add a folder or file to the clipboard for moving.\r\n- **paste**: Paste a folder or file from the clipboard to the current folder or a specified folder.\r\n\r\n### Options\r\n\r\n- `--help`: Display the usage message.\r\n\r\n### Examples\r\n\r\n```bash\r\nmagcopy copy /path/to/source/folder\r\nmagcopy paste /path/to/destination/folder\r\n\r\nmagcopy move /path/to/source/file\r\nmagcopy paste /path/to/destination/folder\r\n```\r\n\r\n## Notes\r\n\r\n- This program does not alter the contents of the system's default clipboard. It maintains its own clipboard for managing copied and moved items.\r\n\r\n## Error Handling\r\n\r\nIn case of errors, the utility provides clear error messages to guide the user.\r\n\r\n## Testing\r\n\r\nTo 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:\r\n\r\n```bash\r\npip install pytest\r\n```\r\n\r\nOnce `pytest` is installed, you can run the tests by executing the following command in the root directory of your project:\r\n\r\n```bash\r\npytest\r\n```\r\n\r\nThis 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.\r\n\r\n### Running Specific Tests\r\n\r\nIf 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:\r\n\r\n```bash\r\npytest tests/test_clipboard.py\r\n```\r\n\r\nThis command will run only the tests defined in the `test_clipboard.py` file.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Contributing\r\n\r\nContributions 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.\r\n\r\n### How to Contribute\r\n\r\n1. Fork the repository on GitHub.\r\n2. Clone your forked repository to your local machine:\r\n\r\n ```bash\r\n git clone https://github.com/your-username/magcopy.git\r\n ```\r\n\r\n3. Create a new branch for your contribution:\r\n\r\n ```bash\r\n git checkout -b feature/your-feature-name\r\n ```\r\n\r\n4. Make your changes and commit them with a descriptive commit message:\r\n\r\n ```bash\r\n git commit -m \"Add your descriptive message here\"\r\n ```\r\n\r\n5. Push your changes to your fork:\r\n\r\n ```bash\r\n git push origin feature/your-feature-name\r\n ```\r\n\r\n6. Open a pull request on the official `magcopy` repository.\r\n\r\n### Reporting Issues\r\n\r\nIf you encounter any issues or have suggestions, please open an issue on the [GitHub issue tracker](https://github.com/your-username/magcopy/issues). Provide detailed information about the problem you're facing or the enhancement you're proposing.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "magcopy is a command-line utility that simplifies the copy and move operations of files and directories between terminal windows.",
"version": "0.0.3.1",
"project_urls": {
"Documentation": "https://github.com/AdaiasMagdiel/magcopy/blob/main/README.md",
"Homepage": "https://github.com/AdaiasMagdiel/magcopy",
"Issues": "https://github.com/AdaiasMagdiel/magcopy/issues",
"Repository": "https://github.com/AdaiasMagdiel/magcopy"
},
"split_keywords": [
"file management",
"command-line utility",
"clipboard",
"copy and move",
"terminal interaction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d99c167e238210d06c639d9dc8ea6750a664123c3a7863468b62475bb805e310",
"md5": "4db40d361af278e7b007e1af7720b3da",
"sha256": "388f9ac566c34eb5d8e55ec9195b7801695f259f1819fa13aaab43202249f91a"
},
"downloads": -1,
"filename": "magcopy-0.0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4db40d361af278e7b007e1af7720b3da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6640,
"upload_time": "2024-01-24T10:37:43",
"upload_time_iso_8601": "2024-01-24T10:37:43.136285Z",
"url": "https://files.pythonhosted.org/packages/d9/9c/167e238210d06c639d9dc8ea6750a664123c3a7863468b62475bb805e310/magcopy-0.0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b822c7bc38e571a11957026566294d56413180607c7811efa49d0dba9b1cac53",
"md5": "ff3efb4e7ad4bce5c318b63c1e943903",
"sha256": "85009b820b7bcc23183fe4d6f8467eb94437cce940c2c78f808b65a38c675db1"
},
"downloads": -1,
"filename": "magcopy-0.0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ff3efb4e7ad4bce5c318b63c1e943903",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5893,
"upload_time": "2024-01-24T10:37:44",
"upload_time_iso_8601": "2024-01-24T10:37:44.731044Z",
"url": "https://files.pythonhosted.org/packages/b8/22/c7bc38e571a11957026566294d56413180607c7811efa49d0dba9b1cac53/magcopy-0.0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 10:37:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AdaiasMagdiel",
"github_project": "magcopy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "magcopy"
}
JSON
