This release brings several updates:
When setting up a database connection, SQLconnect will now check the root of the project for a connections.yaml and .env file. If one or both cannot be found, it will check the users home directory. Saving the configuration files in the home directory is useful if different projects need to share the same configuration, or if you want to reduce the chance of accidently committing .env to version control.
Here are example absolute paths for the home directory it will search on different operating systems:
1. **macOS/Linux**:
- The home directory path typically looks like `/Users/username` on macOS and `/home/username` on most Linux distributions.
- Example path: `/Users/justin/connections.yaml` (macOS) or `/home/justin/connections.yaml` (Linux).
2. **Windows**:
- On Windows, the home directory path often looks like `C:\Users\username`.
- Example path: `C:\Users\justin\connections.yaml`.
Also:
- Exposed the sqlalchmey engine as a property of the SQLconnector class allowing for more direct integration with core sqlalchemy functionality.
- Added unit tests to cover the config and connector modules using the pytest framework.
- Improved docstrings.
- Added example environment variable .env file.
- Added documentation using sphinx framework.