Rename package to fs-queue

README.md

@@ -1,4 +1,4 @@
-# File Queue
+# Filesystem Task Queue
 
 A task queue using the filesystem as the message queue. This project
 was motivated by the use case where it is hard or near impossible to
@@ -27,13 +27,17 @@ chunking them or using plugins like
 breaking it into many small tasks). Each task state modifications
 results in 2-4 IOPS on the filesystem.
 
+# Install
+
+ - `pip install fs-queue`
+
 # API
 
 Creating a queue is as simple as supplying a directory where the queue
 will reside.
 
 ```python
-from file_queue import Queue
+from fs_queue import Queue
 
 queue = Queue("path/to/queue")
 ```
@@ -42,7 +46,7 @@ Submitting jobs and monitoring over SSH is also supported via the same
 interface. Workers currently cannot connect over SSH.
 
 ```python
-from file_queue.plugins import SSHQueue
+from fs_queue.plugins import SSHQueue
 
 queue = SSHQueue("ssh://<username>:<password>@<hostname>:<port>/<path>")
 ```
@@ -75,10 +79,10 @@ Starting a worker is as simple as giving a filesystem directory where
 the queue will reside.
 
 ```shell
-file-queue-worker --path ./path/to/queue
+fs-queue-worker --path ./path/to/queue
 ```
 
-A `dask` worker is supported via `file_queue.plugin.dask.DaskWorker`
+A `dask` worker is supported via `fs_queue.plugin.dask.DaskWorker`
 for sending jobs to the dask cluster instead of executing locally.
 
 A worker runs a continuous loop gathering tasks in the task queue. The
@@ -89,4 +93,4 @@ will:
 
 # License
 
-[BSD-3]()
+[BSD-3](./LICENSE)

fs_queue/__init__.py

@@ -0,0 +1 @@
+from fs_queue.core import Queue, Job, Worker, JobStatus  # noqa

file_queue/__main__.py → fs_queue/__main__.py

@@ -1,4 +1,4 @@
-from file_queue.cli import cli
+from fs_queue.cli import cli
 
 
 def main():

file_queue/core.py → fs_queue/core.py

@@ -10,7 +10,7 @@
 import time
 from typing import Union
 
-from file_queue import utils
+from fs_queue import utils
 
 
 logger = logging.getLogger(__name__)

file_queue/plugins/dask.py → fs_queue/plugins/dask.py

@@ -1,6 +1,6 @@
 import logging
 
-from file_queue.core import Worker, Queue, Job
+from fs_queue.core import Worker, Queue, Job
 
 import distributed
 

file_queue/plugins/filelock.py → fs_queue/plugins/filelock.py

@@ -4,7 +4,7 @@
 
 import filelock
 
-from file_queue.core import DummyLock
+from fs_queue.core import DummyLock
 
 
 class FileLock(DummyLock):

file_queue/plugins/ssh.py → fs_queue/plugins/ssh.py

@@ -7,7 +7,7 @@
 import paramiko
 from paramiko.client import SSHClient
 
-from file_queue.core import Queue, JSONSerializer, DummyLock, Job, JobStatus
+from fs_queue.core import Queue, JSONSerializer, DummyLock, Job, JobStatus
 
 
 class SSHJob(Job):

pyproject.toml

@@ -3,8 +3,8 @@ requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "file-queue"
-description = "File based task queue"
+name = "fs-queue"
+description = "Filesystem based task queue"
 readme = "README.md"
 requires-python = ">=3.7"
 license = {text = "BSD 3-Clause License"}
@@ -18,4 +18,4 @@ dev = ["pytest", "black", "flake8", "build", "twine"]
 extra = ["filelock", "paramiko", "dask", "distributed"]
 
 [project.scripts]
-file-queue-worker = "file_queue.__main__:main"
+fs-queue-worker = "fs_queue.__main__:main"

tests/test_integration.py

@@ -1,5 +1,5 @@
 import file_queue
-from file_queue.plugins.ssh import SSHQueue
+from fs_queue.plugins.ssh import SSHQueue
 
 import operator
 

tests/test_unit.py

@@ -1,4 +1,4 @@
-from file_queue import Queue, JobStatus
+from fs_queue import Queue, JobStatus
 
 
 def add(a: int, b: int):