skoobasteeve/successfactors-python
1
0
Fork 0
mirror of https://github.com/skoobasteeve/successfactors-python.git synced 2026-03-20 03:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2 from skoobasteeve/0.0.10

Browse Source 
update documentation
This commit is contained in:
Ray Lyon
2023-08-08 11:40:36 -04:00
committed by GitHub
parent 7f175514e6 e6d16cb6b1
commit 51949082d2
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,6 +1,16 @@
# SuccessFactors Auth # SuccessFactors Auth
Authenticate with the SAP SuccessFactors API with OAuth2 and Python. Authenticate with the SAP SuccessFactors API with OAuth2 and Python.
## Dependencies
- xmlsec
- requests
## System Requirements
- libxml2 >= 2.9.1
- libxmlsec1 >= 1.2.18
## How to use ## How to use
1. Create an OAuth application in SuccessFactors. 1. Create an OAuth application in SuccessFactors.
@@ -9,6 +19,8 @@ Authenticate with the SAP SuccessFactors API with OAuth2 and Python.
``` shell ``` shell
pip install successfactors_auth pip install successfactors_auth
``` ```
Depending on your OS, you may need to install additional system packages, see [xmlsec documentation](https://pypi.org/project/xmlsec/).
**Note for macOS users:** There is a bug that prevents you from installing xmlsec with Homebrew, currently tracked in a [Github issue](https://github.com/xmlsec/python-xmlsec/issues/254). There are some workaround you can try, but in the mean time it may be easier to install within a container or VM.
4. Import `successfactors_auth` into your Python >=3.9 project. 4. Import `successfactors_auth` into your Python >=3.9 project.
5. Call the `successfactors_auth.get_token()` function in your Python project. You'll need to pass the following parameters: 5. Call the `successfactors_auth.get_token()` function in your Python project. You'll need to pass the following parameters:
- `sf_url`: Base API url of your SuccessFactors instance, e.g. "https://api55.sapsf.eu". - `sf_url`: Base API url of your SuccessFactors instance, e.g. "https://api55.sapsf.eu".

2
pyproject.toml
View File

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project] [project]
name = "successfactors-auth" name = "successfactors-auth"
version = "0.0.9" version = "0.0.10"
authors = [ authors = [
{ name="Ray Lyon", email="ray@raylyon.net" }, { name="Ray Lyon", email="ray@raylyon.net" },
] ]