Skip to content

Commit 0045ad6

Browse files
committed
Better README + Renaming
1 parent d67833c commit 0045ad6

File tree

5 files changed

+23
-3
lines changed

5 files changed

+23
-3
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.vscode/
1+
.vscode/
2+
*/__pycache__/

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
11
# python-movefile-restart
22

3-
A small library to move, delete, and rename files at Windows restart time.
3+
A small library to move, delete, and rename files at Windows restart time.
4+
5+
## Installation
6+
7+
`pip install -e .` or `pip3 install -e .`, depending on your configuration of Python and Pip.
8+
9+
## Usage
10+
11+
To import, use `from movefile_restart import movefile_restart`
12+
13+
From there, you have a couple functions at your disposal:
14+
15+
`movefile_restart.DeleteFile(file_path)`: Queues `file_path` for deletion.
16+
`movefile_restart.MoveFile(from_path, to_path)` or `movefile_restart.RenameFile(from_path, to_path)`: Moves the file from `from_path` to `to_path`.
17+
18+
## Current Limitations
19+
20+
* Files cannot currently be un-queued.
21+
* Some weird cases such as: if you're moving `a.txt` to `b.txt`, you cannot queue a deletion for `b.txt` after your file move queue. You would have to restart the computer so `b.txt` exists before deleting it.
22+
* Due to using the Windows Registry for handling these kinds of operations, no other operating system is supported, nor is there planned support.
File renamed without changes.
File renamed without changes.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="movefile-restart",
8-
version="0.1.0",
8+
version="0.1.1",
99
author="hammy3502",
1010
author_email="hammy275@gmail.com",
1111
description="A small library for Windows to queue files to be moved, deleted, or renamed on reboot.",

0 commit comments

Comments
 (0)