Skip to content

Commit

Permalink
Update docs to reflect Python versions
Browse files Browse the repository at this point in the history
  • Loading branch information
AllanLeanderRostockHansen committed Nov 21, 2023
1 parent 82bc0dd commit a6c42d4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Dremio SQL Lakehouse Arrow Flight Client

![Python3.9](https://img.shields.io/badge/python-3.9-brightgreen?style=flat&logo=python)
![Python3.10](https://img.shields.io/badge/python-3.10-brightgreen?style=flat&logo=python)
![Python3.11](https://img.shields.io/badge/python-3.11-blue?style=flat&logo=python)

Expand Down
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This Dremio Arrow Flight Client is based on [python Official examples](https://g
## Installation Requirements

- A package manger :-> [Pip](https://pip.pypa.io), [Poetry](https://python-poetry.org/docs/master/#installation) or [Conda](https://conda.io/docs/user-guide/install/index.html)
- [Python](http://docs.python-guide.org/en/latest/starting/installation/) (any of 3.7, 3.8, 3.9 or 3.10)
- [Python](http://docs.python-guide.org/en/latest/starting/installation/) (any of 3.9 through 3.11)
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) if installing from source

???+ hint "Experimental Git Branches"
Expand All @@ -28,7 +28,7 @@ This Dremio Arrow Flight Client is based on [python Official examples](https://g

This package is thorougly tested against `python3.7`, `python3.8`, `python3.9` or `python3.10`. Other python3 versions might work but just note they have not been tested.

!!! info "Virtual Environment or Install on OS Filesystem?"
!!! info "Virtual Environment or Install on OS Filesystem?"

Personally I discourage installation on the python base libraries path. I consider it an `evil act` because it may cause unprecedented issues if the package is compromised (we are always onlook for security vulnerabilities but it is always good to be prepared for unexpected eventualities).
In my opinion therefore, it is better to install the package (not just this but also all other packages that you use) in a virtual environment.
Expand All @@ -38,7 +38,7 @@ This Dremio Arrow Flight Client is based on [python Official examples](https://g

Create a virtual environment and activate it.

- Using [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html)
- Using [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html)

```bash
virtualenv -p python3 venv
Expand Down

0 comments on commit a6c42d4

Please sign in to comment.