<div align="center">
<img src="https://github.com/charleshardage/dot-connect/assets/119973756/7d52a0b4-a7c3-4df0-845d-0d73b0a20a42"><br>
</div>
-----------------
# dot-connect
[](https://github.com/learning-the-computers/dot-connect/actions/workflows/pytest_cov.yml)
[](https://codecov.io/github/learning-the-computers/dot-connect)
[](https://pypi.org/project/dot-connect)
A Python package designed to simplify the way you fetch connection configurations and establish connections to various databases and cloud systems.
## 🚀 Features
- **Unified Interface**: Say goodbye to juggling multiple APIs. Enjoy a standardized interface, making connecting with various databases and cloud providers easier.
- **Easy Configuration**: Fetch connection configurations with ease. `dot_connect` supports various sources like JSON files, environment variables, and more, ensuring flexibility and adaptability for your projects.
- **Supported Backends**: Out-of-the-box support for popular systems such as MySQL, Postgres, and Snowflake. We're continuously working to expand this list.
- **Extensibility**: Designed with developers in mind, it's easy to extend and customize `dot_connect` for your needs.
## 📦 Installation (PyPI)
```bash
pip install dot-connect
```
## 🔧 Usage
Using `dot_connect` is intuitive and straightforward.
### Getting Things Set Up
Before you begin, you can configure your environment variables by using a `.env` file or an alternative method. Additionally, you can utilize default authorization patterns supported by your chosen backend. `dot-connect` will prioritize credentials in a `.env` file.
Below are step-by-step examples of how you can connect and query various backends:
#### Snowflake
```python
import dot_connect
con = dot_connect.snowflake.connect()
print(con.cursor().execute("SELECT 1;").fetchall())
```
#### MySQL
```python
import dot_connect
con = dot_connect.mysql.connect()
cursor = con.cursor()
cursor.execute("SELECT 1")
result = cursor.fetchall()
print(result)
```
#### PostgreSQL
```python
import dot_connect
con = dot_connect.postgres.connect()
cursor = con.cursor()
cursor.execute("SELECT 1")
result = cursor.fetchall()
print(result)
```
## 🤝 Contributing
We welcome contributions from the community. Whether it's a bug report, a new feature, or an improvement, your insights will help make `dot_connect` even better. For more details, please see our [contributing guidelines](docs/CONTRIBUTING.md).
## ⚖️ License
Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text.
Raw data
{
"_id": null,
"home_page": "https://github.com/learning-the-computers/dot-connect",
"name": "dot-connect",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Tyler White",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/0b/b9/188c9089b26c8fde95c00e0bd8861869334874ff356541ae715782527555/dot_connect-0.3.32.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://github.com/charleshardage/dot-connect/assets/119973756/7d52a0b4-a7c3-4df0-845d-0d73b0a20a42\"><br>\n</div>\n\n-----------------\n\n# dot-connect\n[](https://github.com/learning-the-computers/dot-connect/actions/workflows/pytest_cov.yml)\n[](https://codecov.io/github/learning-the-computers/dot-connect)\n[](https://pypi.org/project/dot-connect)\n\nA Python package designed to simplify the way you fetch connection configurations and establish connections to various databases and cloud systems.\n\n## \ud83d\ude80 Features\n\n- **Unified Interface**: Say goodbye to juggling multiple APIs. Enjoy a standardized interface, making connecting with various databases and cloud providers easier.\n\n- **Easy Configuration**: Fetch connection configurations with ease. `dot_connect` supports various sources like JSON files, environment variables, and more, ensuring flexibility and adaptability for your projects.\n\n- **Supported Backends**: Out-of-the-box support for popular systems such as MySQL, Postgres, and Snowflake. We're continuously working to expand this list.\n\n- **Extensibility**: Designed with developers in mind, it's easy to extend and customize `dot_connect` for your needs.\n\n## \ud83d\udce6 Installation (PyPI)\n\n```bash\npip install dot-connect\n```\n\n## \ud83d\udd27 Usage\n\nUsing `dot_connect` is intuitive and straightforward.\n\n### Getting Things Set Up\n\nBefore you begin, you can configure your environment variables by using a `.env` file or an alternative method. Additionally, you can utilize default authorization patterns supported by your chosen backend. `dot-connect` will prioritize credentials in a `.env` file.\n\nBelow are step-by-step examples of how you can connect and query various backends:\n\n#### Snowflake\n\n```python\nimport dot_connect\n\ncon = dot_connect.snowflake.connect()\nprint(con.cursor().execute(\"SELECT 1;\").fetchall())\n```\n\n#### MySQL\n```python\nimport dot_connect\n\ncon = dot_connect.mysql.connect()\ncursor = con.cursor()\ncursor.execute(\"SELECT 1\")\nresult = cursor.fetchall()\nprint(result)\n```\n\n#### PostgreSQL\n```python\nimport dot_connect\n\ncon = dot_connect.postgres.connect()\ncursor = con.cursor()\ncursor.execute(\"SELECT 1\")\nresult = cursor.fetchall()\nprint(result)\n```\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions from the community. Whether it's a bug report, a new feature, or an improvement, your insights will help make `dot_connect` even better. For more details, please see our [contributing guidelines](docs/CONTRIBUTING.md).\n\n## \u2696\ufe0f License\nLicensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Improve your workflow efficiency by connecting to databases and cloud systems effortlessly.",
"version": "0.3.32",
"project_urls": {
"Homepage": "https://github.com/learning-the-computers/dot-connect"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26d23288949529674aef1d6c3df180ed74b17573bb32dd9b56151f5e3bfeed20",
"md5": "3455a852fed48d30a94a89aa56a4235b",
"sha256": "d422e15efde9da8efdb4e485c29d8d8e3605625f608e4dcb06dfc54e14dd21b9"
},
"downloads": -1,
"filename": "dot_connect-0.3.32-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3455a852fed48d30a94a89aa56a4235b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18344,
"upload_time": "2023-08-28T22:38:16",
"upload_time_iso_8601": "2023-08-28T22:38:16.014347Z",
"url": "https://files.pythonhosted.org/packages/26/d2/3288949529674aef1d6c3df180ed74b17573bb32dd9b56151f5e3bfeed20/dot_connect-0.3.32-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0bb9188c9089b26c8fde95c00e0bd8861869334874ff356541ae715782527555",
"md5": "d2127084e0ed4e199e02d27bc314d59a",
"sha256": "f2ff4f46f5d6e42caa7408abc0c38bf9e50047f5740458f547785d973c1379ef"
},
"downloads": -1,
"filename": "dot_connect-0.3.32.tar.gz",
"has_sig": false,
"md5_digest": "d2127084e0ed4e199e02d27bc314d59a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15420,
"upload_time": "2023-08-28T22:38:17",
"upload_time_iso_8601": "2023-08-28T22:38:17.518799Z",
"url": "https://files.pythonhosted.org/packages/0b/b9/188c9089b26c8fde95c00e0bd8861869334874ff356541ae715782527555/dot_connect-0.3.32.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-28 22:38:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "learning-the-computers",
"github_project": "dot-connect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "dot-connect"
}
JSON
