Package namespace and dev notes (#19)

* organise import names and add accompanying tests

* ignore VSCode-related files

* dependencies version bump

* add note on development environment

.gitignore

@@ -9,6 +9,7 @@ gertils.egg-info/
 
 # IDE-related
 .idea/
+.vscode/
 
 # Other
 .nox/

README.md

@@ -9,3 +9,12 @@ These tools are organised by use case at the module level; that is, tools that a
 - [gpu.py](./gertils/gpu.py) -- tools for running computations on GPUs, especially with TensorFlow
 - [group_paths.py](./gertils/group_paths.py) -- tools for working with Gerlich group paths on filesystems
 - [pathtools.py](./gertils/pathtools.py) -- tools for working with filesystem paths generally
+
+## Development
+This project is configured to use Nix for a shell/environment with dependencies, and Nox to make common development commands/workflows easier. Start always with `nix-shell`. If it takes a long time to build, try...
+1. Stop the shell build: `Ctrl-c`
+1. Remove the Poetry lockfile: `rm poetry.lock`
+1. Clear Poetry's PyPI cache (assuming you have an active Nix shell): `poetry cache clear PyPI --all`
+1. Exit Nix shell: `Ctrl-d`
+1. Rebuild Nix shell: `shell.nix`
+

gertils/__init__.py

@@ -0,0 +1,7 @@
+"""Package-level names"""
+
+# mypy: ignore-errors
+
+from .collection_extras import *
+from .exceptions import *
+from .pathtools import *

gertils/pathtools.py

@@ -4,7 +4,6 @@
 from dataclasses import dataclass
 from pathlib import Path
 from typing import *
-from typing import Any
 
 __all__ = ["ExtantFile", "ExtantFolder", "NonExtantPath", "PathWrapperException"]
 __author__ = "Vince Reuter"