Adobe Target Python SDK
Project description
Adobe Target Python SDK
Requirements
All currently maintained versions of Python are supported, see Python Releases. Older Python releases may likely work too, but are not officially supported.
NPM 6+ (required by openapi-generator-cli)
Java 8+ (required by openapi-generator)
GNU Make
Set PYTHON_PATH
Various build commands are supported via Makefile, but first you must export environment variable PYTHON_PATH to specify which python install to use to set up your virtual env.
$ export PYTHON_PATH=python2.7 # Symlink to Mac OS built-in version of python
$ export PYTHON_PATH=/usr/local/bin/python3
Setup virtual env to make it easy to switch between python 2.7 and 3
$ make new_env # Deletes existing virtual env and creates new one based on PYTHON_PATH
$ make install # Install dependencies in virtual env
Code generation
The SDK depends on Target Open API. It uses Open API and the Open API generator
to generate the low level HTTP client.
To be able to use Target Open API
for code generation, we are leveraging Git subtree.
To import Target Open API
as openapi
folder please use commands:
$ git subtree add --prefix openapi git@github.com:adobe/target-openapi.git main --squash
To refresh the imported subtree use this command:
$ git subtree pull --prefix openapi git@github.com:adobe/target-openapi.git main --squash
Once all the tools are installed, there is no need to invoke them directly, everything is wrapped in a Makefile
command, which can be invoked by running:
$ make codegen
Run tests and format code
$ make test
$ make format
Release build package
Releases are triggered through Github publish workflow. Input version part to update before publishing to pypi - [patch, minor, major]
Running Github Workflows on forked repositories
Github Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
See more details at https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#pull-request-events-for-forked-repositories
Contributing
Contributions are welcomed! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for target_python_sdk-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b792f2e4914cb951d01be5b01cf179a0ab80f93000fb5a99086325e916a5ddc6 |
|
MD5 | f696e18253c50fef4ab61261b9e0e2f0 |
|
BLAKE2b-256 | 0a271cd282b0fbcc0e4c6d86ee05fe2883c0ab058504b4e46280240ee790f221 |