Skip to content

Commit

Permalink
upgrading version and adding notes
Browse files Browse the repository at this point in the history
  • Loading branch information
pitchmuc committed Jun 19, 2023
1 parent afc25e2 commit 172d9ce
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion aanalytics2/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.3.3-3"
__version__ = "0.4.0"
11 changes: 11 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,17 @@ import aanalytics2 as api2
api2.createConfigFile()
```


This will create a JSON and you will need to fill it with the information available in your adobe io account.

**NOTE**: starting version 0.4.0 the `createConfigFile` will by default create a Oauth Server to Server configuration file.
You can always use the argument to change the behavior.

Arguments for `createConfigFile`:

* destination : OPTIONAL : the name of the file + path if you want
* auth_type : OPTIONAL : The type of Oauth type you want to use for your config file. Possible value: "jwt" or "oauthV2"

## 4. Import the configuration file

Once this is done, you can import the configuration file.
Expand All @@ -48,6 +57,8 @@ import aanalytics2 as api2
api2.importConfigFile('myconfig.json')
```

**Note**: starting version 0.4.0 the `importConfigFile` will check dynamically for the keys used to define the type of Auth. The check is Oauth V2 and then JWT. You can force the usage of a specific setup by passing the type of auth you want to priorize.

### Alternative 1 : Using the configure method

When you want to connect to the Analytics API from a server application, you may want to use the `configure` method and passing the element directly.
Expand Down
1 change: 1 addition & 0 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The changes have been tracked starting version 0.1.0
* Oauth Token V2 is the new default support when creating a config file
* better respecting existing parameter via getReport2
* raising exception on error for generating token
* deepcopying the request made to `getReport2` method to avoid modification on original variable.

## version 0.3.3

Expand Down

0 comments on commit 172d9ce

Please sign in to comment.