Skip to content

Commit

Permalink
Merge pull request #378 from VorTECHsa/fix-m1-sdk
Browse files Browse the repository at this point in the history
Fix SDK for M1 users
  • Loading branch information
Selerski authored Sep 28, 2022
2 parents 798553e + 2d6f95a commit eab755e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 6 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ ideal report includes:

## Setting up your environment

**`Users of ARM-based Apple machines, please refer to the note at the end!`**

First, clone the repo, then `cd` into the repo.

```bash
Expand Down Expand Up @@ -79,6 +81,16 @@ $ pre-commit install

:tada: Now you're ready to create a new branch, add a feature or fix a bug, then send us a pull request! :tada:

### Note about Apple ARM-based chips

To run the SDK on an Apple ARM chip, upgrade your Python version to 3.8 or higher and use the latest version of pip. This works for the SDK version 0.41.0 or higher.

The set up is almost identical as above except one command; to create a virtual environment for Python 3.8 you should run:

```bash
$ python3.8 -m venv venv
```

## Contributing Code

### Releasing a new package
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ $ pip install vortexasdk
The SDK requires Python version 3.7 or above, see
[Setup FAQ](https://vortechsa.github.io/python-sdk/faq_setup/) for more details.

To install the SDK on an Apple ARM-based machine, use Python version to 3.8 or higher and use the latest version of pip. This is supported in the SDK versions 0.41.0 or higher.

##### Authentication

Set your `VORTEXA_API_KEY` environment variable, that's all. Alternatively, the
Expand Down
10 changes: 5 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@
install_requires=[
"flatten-dict==0.4.2",
"jupyter==1.0.0",
"matplotlib==3.3.4",
"matplotlib==3.5.3",
"pandas>=0.25.2",
"requests==2.28.1",
"statsmodels==0.12.2",
"tqdm==4.38.0",
"pydantic==1.9.2",
"statsmodels==0.13.2",
"tqdm==4.64.1",
"pydantic==1.10.2",
],
extras_require={
"tests": [
Expand All @@ -54,6 +54,6 @@
"types-python-dateutil==2.8.19",
"types-six==1.16.19"
],
"deploy": ["wheel==0.36.2", "twine==3.3.0"],
"deploy": ["wheel==0.37.1", "twine==4.0.1"],
},
)
2 changes: 1 addition & 1 deletion vortexasdk/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.40.1"
__version__ = "0.41.0"

0 comments on commit eab755e

Please sign in to comment.